Skip to content

Commit 171838d

Browse files
authored
doc: update Readme (#57)
* add notes for python version and mac installation * add downloads counts * move mac nots
1 parent 9f3a369 commit 171838d

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
[![arXiv](https://img.shields.io/badge/arXiv-2405.04967-blue?logo=arxiv&logoColor=white.svg)](https://arxiv.org/abs/2405.04967)
1212
[![Requires Python 3.9+](https://img.shields.io/badge/Python-3.9+-blue.svg?logo=python&logoColor=white)](https://python.org/downloads)
13-
13+
[![PyPI Downloads](https://static.pepy.tech/badge/mattersim)](https://pepy.tech/projects/mattersim)
1414
</h4>
1515

1616

@@ -23,7 +23,8 @@ This README provides a quick start guide. For more comprehensive information, pl
2323
## Installation
2424

2525
### Prerequisite
26-
* Python==3.9
26+
* `Python >= 3.9`
27+
2728

2829
### Install from PyPI
2930
> [!TIP]
@@ -37,6 +38,7 @@ This README provides a quick start guide. For more comprehensive information, pl
3738
> conda activate mattersim
3839
> ```
3940
>
41+
> Although MatterSim can be installed with `Python > 3.9`, we recommend using `Python == 3.9` for optimal compatibility.
4042
4143
To install MatterSim, use the following command. Please note that downloading the dependencies may take some time:
4244
```bash
@@ -73,6 +75,9 @@ python setup.py build_ext --inplace
7375

7476
## Usage
7577

78+
> [!TIP]
79+
> **Note for macOS Users:** If you are using macOS with Apple Silicon, please be aware of potential numerical instability with the MPS backend. We recommend using the CPU device for MatterSim on Mac to avoid these issues.
80+
7681
### A minimal test
7782
```python
7883
import torch

0 commit comments

Comments
 (0)