Skip to content

Commit

Permalink
Comment test suite in install.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SunyongKwon committed Jul 18, 2024
1 parent af31db9 commit 638cdc0
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ pip install equilipy
{: .warning }
`equilipy` requires a Fortran compiler in the local environment. To install a Fortran compiler, please follow [Preinstall][preinstall].

{: .note }
The test suite in the `./test/*` directory is integrated into the build process for .whl files using GitHub Actions. No further testing is necessary when installing via pip.

For **HPC environment**, use `equilipy-hpc` instead of `equilipy`
```
pip install equilipy-hpc
Expand Down Expand Up @@ -49,5 +52,8 @@ export CC=/usr/local/Cellar/gcc/*/bin/gcc-*
pip install wheelhouse/equilipy-*.whl
```

{: .note }
When building equilipy from the source, consider running the test suite located in the `./test/*` directory. This test suite ensures the reliability of the core functions in equilipy.

[preinstall]: https://github.com/ORNL/Equilipy/blob/main/docs/preinstall.md
[equilipy]: https://github.com/ORNL/Equilipy
[equilipy]: https://github.com/ORNL/Equilipy

0 comments on commit 638cdc0

Please sign in to comment.