Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yanghan-microsoft committed Nov 29, 2024
1 parent f22a41b commit 5149ce9
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,23 @@
MatterSim is a deep learning atomistic model across elements, temperatures and pressures.

## Installation
### Install from PyPI
<details>
<summary>Notes</summary>
Although this is not mandatory, we recommend you to create a clean conda environment before attempting to install MatterSim. You can create a conda environment with the following command:
```bash
# create the environment
conda create -n mattersim python=3.9
# activate the environment
conda activate mattersim
```
</details>

To install MatterSim, run the following command:
```
pip install mattersim
```

### Install from source code
> [!WARNING]
> We strongly recommend that users install MatterSim using [mamba or micromamba](https://mamba.readthedocs.io/en/latest/index.html), because *conda* can be significantly slower when resolving the dependencies in environment.yaml.
Expand Down

0 comments on commit 5149ce9

Please sign in to comment.