Skip to content

Commit

Permalink
doc: update Readme (#57)
Browse files Browse the repository at this point in the history
* add notes for python version and mac installation

* add downloads counts

* move mac nots
  • Loading branch information
yanghan234 authored Dec 5, 2024
1 parent 9f3a369 commit 171838d
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

[![arXiv](https://img.shields.io/badge/arXiv-2405.04967-blue?logo=arxiv&logoColor=white.svg)](https://arxiv.org/abs/2405.04967)
[![Requires Python 3.9+](https://img.shields.io/badge/Python-3.9+-blue.svg?logo=python&logoColor=white)](https://python.org/downloads)

[![PyPI Downloads](https://static.pepy.tech/badge/mattersim)](https://pepy.tech/projects/mattersim)
</h4>


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

### Prerequisite
* Python==3.9
* `Python >= 3.9`


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

## Usage

> [!TIP]
> **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.
### A minimal test
```python
import torch
Expand Down

0 comments on commit 171838d

Please sign in to comment.