Bug reports and requests for features should be made via the issues.
If you want to contribute to this package yourself, please fork, create a feature branch and then make a PR from your feature branch to the upstream ephyspy (see here for details).
You can install via setup.py using pip install -e ".[dev]" (the dev flag installs development and testing dependencies). However at the moment the development environment is incomplete.
For docstrings and comments, please adhere to Google Style.
Code needs to pass through the following tools, which are installed alongside ephyspy:
black: Automatic code formatting for Python. You can
run black manually from the console using black . in the top directory of the
repository, which will format all files.
isort: Used to consistently order
imports. You can run isort manually from the console using isort in the top
directory.
pyright: Used for static type checking. (This is not currently enforced, but planned for a future release).
black and isort and pyright are checked as part of our CI actions. If these
checks fail please make sure you have installed the latest versions for each of them
and run them locally.