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 c44ddb3 commit 3fc36b3
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,24 +44,24 @@ pip install git+https://github.com/microsoft/mattersim.git
### Install from source code
1. Download the source code of MatterSim and change to the directory

```bash
git clone [email protected]:microsoft/mattersim.git
cd mattersim
```
```bash
git clone [email protected]:microsoft/mattersim.git
cd mattersim
```

2. Install MatterSim

> [!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.
> [!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.
To install the package, run the following command under the root of the folder:
To install the package, run the following command under the root of the folder:

```bash
mamba env create -f environment.yaml
mamba activate mattersim
pip install -e .
python setup.py build_ext --inplace
```
```bash
mamba env create -f environment.yaml
mamba activate mattersim
pip install -e .
python setup.py build_ext --inplace
```

## Usage
### A minimal test
Expand Down

0 comments on commit 3fc36b3

Please sign in to comment.