This page contains some general information about this project, and recommendations about contributing.
If you like this package, consider contributing! We welcome bug reports, examples that can be added to the documentation, or new feature proposals.
Below some conventions that we follow when contributing to this package are detailed. For specific guidelines on documentation, see the Documentations Guidelines wiki.
Each pull request (PR) should be pushed in a new branch with the name of the author followed by a descriptive name, e.g.
t/mforets/my_feature. If the branch is associated to a previous discussion in one issue, we use the name of the issue for easier lookup, e.g.
Unit testing and continuous integration (CI)
This project is synchronized with Travis CI, such that each PR gets tested before merging (and the build is automatically triggered after each new commit). For the maintainability of this project, it is important to understand and fix the failing doctests if they exist. We develop in Julia v0.6.0, but for experimentation we also build on the nightly branch.
To run the unit tests locally, you should do:
$ julia --color=yes test/runtests.jl
Contributing to the documentation
This documentation is written in Markdown, and it relies on Documenter.jl to produce the HTML layout. To build the docs, run
$ julia --color=yes docs/make.jl
This repository was originally motivated by the mathematical approach described in Reach Set Approximation through Decomposition with Low-dimensional Sets and High-dimensional Matrices, Sergiy Bogomolov, Marcelo Forets, Goran Frehse, Andreas Podelski, Christian Schilling, Frédéric Viry, in 21st ACM International Conference on Hybrid Systems: Computation and Control, 2018 Edition (Porto, Portugal), see the arXiv pre-print here.
For a full references list of algorithms implemented in this repository, consult the References wiki.
Here we list the names of the contributors to
Reachability.jl (in alphabetic order).
- Aadesh Deshmukh
- Bruno Garate
- Kostiantyn Potomkin
- Moritz Schauer
- Frédéric Viry
We are also grateful to the following persons for enlightening discussions: