This section is still work in progress
We use poetry to manage the dependencies and the virtual environment, so it makes things easier if you need to install it first; check the official documentation for more details.
Clone the repository and install the dependencies:
git clone https://github.com/haddocking/arctic3d.git && cd arctic3d
poetry install
OR if you prefer pip
git clone https://github.com/haddocking/arctic3d.git && cd arctic3d
pip install . pytest-cov
pytest --cov=./ --cov-report=xml -v
We use trunk as the "all-purpose" linting tool, check its documentation.
To check for code style issues, run:
trunk check
To automatically fix the issues, run:
trunk fmt
If you are using VSCode, then this extension make it easy to check for style errors.