For development you should install sorunlib from source (choice of environment is left to the reader):
$ git clone https://github.com/simonsobs/sorunlib.git $ cd sorunlib $ pip install -e .[tests,docs]
This will install an editable version with the optional dependencies for testing and building the docs.
Contributors should follow the recommendations made in the SO Developer Guide. A brief summary is:
- Follow PEP08
- Use "Google Style" docstrings
To help with styling we use pre-commit. You can install the pre-commit hooks with:
$ pip install pre-commit $ pre-commit install
This will then run several hooks, including flake8 on edited files before committing.
main is the only long-lived branch. Please create feature branches and PR
onto main.
This library is critical to running observations at the site. While we will be testing sorunlib in the labs, please include unit tests with your PRs, or explicitly exclude code from coverage if there is good reason that it should not be tested.