From 3fc36b32f9e40c45d55c866c22045818ac0bd7b4 Mon Sep 17 00:00:00 2001 From: Han Yang Date: Fri, 29 Nov 2024 04:55:44 +0000 Subject: [PATCH] update readme --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 6011741..e343354 100644 --- a/README.md +++ b/README.md @@ -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 git@github.com:microsoft/mattersim.git - cd mattersim - ``` +```bash +git clone git@github.com: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