Skip to content

Commit

Permalink
deploy: 51e0949
Browse files Browse the repository at this point in the history
  • Loading branch information
yanghan234 committed Nov 28, 2024
1 parent 1b33cb0 commit 1f7e100
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 21 deletions.
25 changes: 17 additions & 8 deletions _sources/user_guide/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,25 @@
Installation
============

Install from PyPI
-----------------

To install the package, run the following command:

.. code-block:: console
pip install mattersim
In case you want to install the package with the latest version, you can run the following command:

.. code-block:: console
pip install git+https://github.com/microsoft/mattersim.git
Install from source code
------------------------

Requirements:

* Python == 3.9

To install the package, run the following command under the root of the folder:

Expand All @@ -17,11 +30,7 @@ To install the package, run the following command under the root of the folder:
conda activate mattersim
pip install -e .
Obtain the model checkpoints
Model checkpoints
----------------------------

You may obtain our model checkpoints from

.. code-block:: console
# link to somewhere
The currently available model checkpoints can be found in the `MatterSim GitHub repository <https://github.com/microsoft/mattersim/tree/main/src/mattersim/pretrained_models>`_.
Binary file modified objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 1f7e100

Please sign in to comment.