From c05017e3f25f8f4df6947b437e5f12f1ecb124b4 Mon Sep 17 00:00:00 2001 From: Sangjoon Bob Lee Date: Thu, 29 Aug 2024 13:53:37 -0400 Subject: [PATCH] Include testing in documentation --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 699e3c4..e398513 100644 --- a/README.md +++ b/README.md @@ -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