Skip to content

Commit

Permalink
Include testing in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bobleesj authored Aug 29, 2024
1 parent 222e9e8 commit c05017e
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,20 @@ pip install cifkit pyvista gemmi
`gemmi` is used for parsing `.cif` files. `pyvista` is used for plotting
polyhedrons.

Please check the `pyproject.toml` file for the full list of dependencies.

## Testing

To run test locally.

```python
# Install all dependencies in editable mode
pip install -e .

# Run test
pytest
```

## Visuals

### Polyhedron
Expand Down

0 comments on commit c05017e

Please sign in to comment.