Skip to content

Commit

Permalink
Add instructions for setting up optional dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
lan496 committed Apr 17, 2022
1 parent 3d5adb4 commit 0aacddd
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs_rst/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,12 @@ Direct contributions to pymatgen main distribution

Note that the entire Github repo is fairly large because of the presence of test files, but these are absolutely
necessary for rigorous testing of the code.
5. It is highly recommended you install all the optional dependencies as well.
5. It is highly recommended you install all the optional dependencies as well::

pip install -r requirements.txt
pip install -r requirements-optional.txt
pip install -r requirements-dev.txt

6. Code (see `Coding Guidelines`_). Commit early and commit often. Keep your code up to date. You need to add the main
repository to the list of your remotes. Let's name the upstream repo as mpmaster (materialsproject master)::

Expand Down

0 comments on commit 0aacddd

Please sign in to comment.