Contributions are welcome, and they are greatly appreciated! The development of this package takes place on GitHub. Issues, bugs, and feature requests should be reported there. Code and documentation can be improved by submitting a pull request. Please add documentation and tests for any new code.
The package can be set up (ideally in a virtual environment) for local development with the following:
$ git clone https://github.com/epfl-lts2/pygsp.git $ pip install -U -r pyunlocbox/requirements.txt $ pip install -e pyunlocbox
You can improve or add solvers, functions, and acceleration schemes in
pyunlocbox/acceleration.py, along with their corresponding unit tests in
pyunlocbox/tests/test_*.py (with reasonable coverage) and documentation in
doc/reference/*.rst. If you have a nice example to demonstrate the use of
the introduced functionality, please consider adding a tutorial in
Do not forget to update
doc/history.rst with e.g. new
features. The version number needs to be updated in
After making any change, please check the style, run the tests, and build the documentation with the following (enforced by Travis CI):
$ make lint $ make test $ make doc
Check the generated coverage report at
htmlcov/index.html to make sure the
tests reasonably cover the changes you’ve introduced.