From 7ec739763765c297fad0ce646b0b9b449f98cee7 Mon Sep 17 00:00:00 2001 From: Misko Date: Thu, 1 Aug 2024 21:31:08 -0700 Subject: [PATCH] list available fairchem packages; and show how to use pytest in [dev] (#790) --- docs/core/install.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/core/install.md b/docs/core/install.md index 8ad523f32..5eb4569f8 100644 --- a/docs/core/install.md +++ b/docs/core/install.md @@ -44,28 +44,28 @@ You can also install `pytorch` and `torch_geometric` dependencies from PyPI to s similarly by selecting the appropriate versions in the official [PyG docs](https://pytorch-geometric.readthedocs.io/en/latest/notes/installation.html) -## Install fairchem-core +## Standard installation of fairchem-core Install `fairchem-core` from PyPi ```bash pip install fairchem-core ``` -## Additional packages - +### Additional packages `fairchem` is a namespace package, meaning all packages are installed seperately. If you need to install other packages you can do so by: ```bash pip install fairchem-{package-to-install} ``` +Available `fairchem` packages are `fairchem-core`,`fairchem-data-oc`,`fairchem-demo-ocpapi`,`fairchem-applications-cattsunami` -## Development install - +## Development installation If you plan to make contributions you will need to fork and clone (for windows user please see next section) the repo, set up the environment, and install fairchem-core from source in editable mode with dev dependencies, ```bash git clone https://github.com/FAIR-Chem/fairchem.git cd fairchem pip install -e packages/fairchem-core[dev] +pytest tests/core ``` And similarly for any other namespace package: