From 9b5a9ce26b108249f5f19aefdf67d7c94046eb4b Mon Sep 17 00:00:00 2001 From: Marcelo Forets Date: Sun, 14 Jan 2024 12:33:05 +0000 Subject: [PATCH 1/4] Update README.md --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 441d940c..8133d880 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,10 @@ | **Documentation** | **Status** | **Community** |**Version-specific Citation** | **License** | |:-----------------:|:----------:|:-------------:|:----------------------------:|:-----------:| -| [![docs-dev][dev-img]][dev-url] | [![CI][ci-img]][ci-url] [![codecov][cov-img]][cov-url] | [![zulip][chat-img]][chat-url] | [![zenodo][doi-img]][doi-url] | [![license][lic-img]][lic-url] | +| [![paper][paper-img]][paper-url] [![docs-dev][dev-img]][dev-url] | [![CI][ci-img]][ci-url] [![codecov][cov-img]][cov-url] | [![zulip][chat-img]][chat-url] | [![zenodo][doi-img]][doi-url] | [![license][lic-img]][lic-url] | +[paper-img]: https://proceedings.juliacon.org/papers/10.21105/jcon.00122/status.svg +[paper-url]: https://doi.org/10.21105/jcon.00122 [dev-img]: https://img.shields.io/badge/docs-latest-blue.svg [dev-url]: https://juliareach.github.io/RangeEnclosures.jl/dev/ [ci-img]: https://github.com/JuliaReach/RangeEnclosures.jl/workflows/CI/badge.svg @@ -17,7 +19,11 @@ [lic-img]: https://img.shields.io/github/license/mashape/apistatus.svg [lic-url]: https://github.com/JuliaReach/RangeEnclosures.jl/blob/master/LICENSE -A [Julia](http://julialang.org) package to bound the range of real-valued functions. +A [Julia](http://julialang.org) package to bound the range of real-valued functions. The following article showcases the basic functionality, highlighting some of the key design choices: + +> Luca Ferranti, Marcelo Forets, and Christian Schilling. *RangeEnclosures.jl: A framework to bound function ranges* [Proceedings of the JuliaCon Conferences](https://doi.org/10.21105/jcon.00122) (2024). + +See [below](#-how-to-cite) for how to cite it. ## Installing From 8bdff321b62b4b66f2096e51d5ff277a43d57713 Mon Sep 17 00:00:00 2001 From: Marcelo Forets Date: Fri, 19 Jan 2024 15:08:05 +0000 Subject: [PATCH 2/4] Update README.md Co-authored-by: Christian Schilling --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8133d880..02f6f8ee 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # RangeEnclosures.jl -| **Documentation** | **Status** | **Community** |**Version-specific Citation** | **License** | +| **Introduction & Documentation** | **Status** | **Community** |**Version-specific Citation** | **License** | |:-----------------:|:----------:|:-------------:|:----------------------------:|:-----------:| | [![paper][paper-img]][paper-url] [![docs-dev][dev-img]][dev-url] | [![CI][ci-img]][ci-url] [![codecov][cov-img]][cov-url] | [![zulip][chat-img]][chat-url] | [![zenodo][doi-img]][doi-url] | [![license][lic-img]][lic-url] | From c80e61132a947e39ad13dcc894fe0cf8be57de45 Mon Sep 17 00:00:00 2001 From: Marcelo Forets Date: Fri, 19 Jan 2024 15:11:34 +0000 Subject: [PATCH 3/4] Update README.md --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 02f6f8ee..6947430e 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,27 @@ features or fixing bugs are also welcome. Make sure to check out the - [Marcelo Forets](https://github.com/mforets) - [Christian Schilling](https://github.com/schillic) +## How to cite + +If you use this package in your work, please cite it using the metadata [here](CITATION.bib) or below: + +``` +@article{Ferranti2024, + author = {Luca Ferranti and + Marcelo Forets and + Christian Schilling}, + title = {{RangeEnclosures}.jl: A framework to bound function ranges}, + journal = {Proceedings of the JuliaCon Conferences}, + volume = {1}, + number = {1}, + pages = {3}, + year = {2024}, + publisher = {The Open Journal}, + url = {https://doi.org/10.21105/jcon.00122}, + doi = {10.21105/jcon.00122} +} +``` + ## Acknowledgments Huge thanks to all the [contributors](https://github.com/JuliaReach/RangeEnclosures.jl/graphs/contributors). From 9d49d4779f265e316c8c6eff15c24a742c5eedfb Mon Sep 17 00:00:00 2001 From: Marcelo Forets Date: Fri, 19 Jan 2024 15:11:49 +0000 Subject: [PATCH 4/4] Create CITATION.bib --- CITATION.bib | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 CITATION.bib diff --git a/CITATION.bib b/CITATION.bib new file mode 100644 index 00000000..3dfef068 --- /dev/null +++ b/CITATION.bib @@ -0,0 +1,14 @@ +@article{Ferranti2024, + author = {Luca Ferranti and + Marcelo Forets and + Christian Schilling}, + title = {{RangeEnclosures}.jl: A framework to bound function ranges}, + journal = {Proceedings of the JuliaCon Conferences}, + volume = {1}, + number = {1}, + pages = {3}, + year = {2024}, + publisher = {The Open Journal}, + url = {https://doi.org/10.21105/jcon.00122}, + doi = {10.21105/jcon.00122} +}