Skip to content

Commit

Permalink
Merge pull request #162 from JuliaReach/mforets-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
schillic authored Jan 19, 2024
2 parents 614c513 + 9d49d47 commit e14c2f2
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 3 deletions.
14 changes: 14 additions & 0 deletions CITATION.bib
Original file line number Diff line number Diff line change
@@ -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}
}
33 changes: 30 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# RangeEnclosures.jl

| **Documentation** | **Status** | **Community** |**Version-specific Citation** | **License** |
| **Introduction & 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
Expand All @@ -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

Expand Down Expand Up @@ -81,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).
Expand Down

0 comments on commit e14c2f2

Please sign in to comment.