Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pedrobcst authored Mar 25, 2022
1 parent f664866 commit c5f0ff0
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ conda create -n Xerus python==3.8 anaconda
conda activate Xerus
git clone http://www.github.com/pedrobcst/Xerus/
cd Xerus
pip install -r requirements.txt
pip install -e .
```
> :warning: You might have trouble installing pymatgen if gcc is not present in your system. You can them for example do sudo apt install g++ to install in Ubuntu, then run pip install -r requirements.txt again.
Expand Down Expand Up @@ -109,7 +109,7 @@ If all the above steps were done sucessfuly (pip install, mongo running [locally
please do the following:
```bash
cd tests
pytest
pytest -vvv
```
If all tests sucessfuly pass, _Xerus_ should be ready for use.

Expand All @@ -118,7 +118,9 @@ If all tests sucessfuly pass, _Xerus_ should be ready for use.

- To learn how to use Xerus, please follow the Notebook, located at Examples/Examples.ipynb

> :warning: Make sure that before running the examples, you have started the MongoDB server.
> :warning: Make sure that before running the examples, you have started the MongoDB server.
> Note: We are developing an ease of use Streamlit interface in [Xerus-streamlit](https://www.github.com/pedrobcst/Xerus-streamlit) repository. Contriubtions are welcome.
# Citing
If you use _Xerus_ please __also__ cite the following papers:
Expand Down

0 comments on commit c5f0ff0

Please sign in to comment.