Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ElliottKasoar committed Feb 5, 2024
1 parent da2f1d3 commit d087170
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,15 @@ verdi data mlip export <PK>

## Development

1. Install [poetry](https://python-poetry.org/docs/#installation)
2. (Optional) Create a virtual environment
3. Install `aiida-mlip` with dependencies:

```shell
git clone https://github.com/aiidateam/aiida-mlip .
git clone https://github.com/stfc/aiida-mlip
cd aiida-mlip
pip install --upgrade pip
pip install -e .[pre-commit,testing] # install extra dependencies
poetry install --with pre-commit,dev,docs # install extra dependencies
pre-commit install # install pre-commit hooks
pytest -v # discover and run all tests
```
Expand All @@ -115,7 +119,6 @@ See the [developer guide](https://stfc.github.io/aiida-mlip/developer_guide/inde

BSD 3-Clause License


[ci-badge]: https://github.com/stfc/aiida-mlip/workflows/ci/badge.svg?branch=main
[ci-link]: https://github.com/stfc/aiida-mlip/actions
[cov-badge]: https://coveralls.io/repos/github/stfc/aiida-mlip/badge.svg?branch=main
Expand Down

0 comments on commit d087170

Please sign in to comment.