From 171838d33e6db3236977d96a39ed35261a28d732 Mon Sep 17 00:00:00 2001 From: Han Yang Date: Thu, 5 Dec 2024 21:40:39 +0800 Subject: [PATCH] doc: update Readme (#57) * add notes for python version and mac installation * add downloads counts * move mac nots --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c941941..5c172c4 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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] @@ -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 @@ -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