Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update Readme #57

Merged
merged 3 commits into from
Dec 5, 2024
Merged

doc: update Readme #57

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
30fa66c
add notes for python version and mac installation
yanghan234 Dec 5, 2024
e27b23b
add downloads counts
yanghan234 Dec 5, 2024
2095ef9
move mac nots
yanghan234 Dec 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
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,8 @@ 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.
> Additionally, if you are using Mac OS X with Apple Silicon, please be aware of potential numerical instability with the MPS backend. In such cases, we advise using the CPU device for MatterSim.

To install MatterSim, use the following command. Please note that downloading the dependencies may take some time:
```bash
Expand Down
Loading