Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rlaplaza authored Dec 1, 2022
1 parent 754df72 commit d8a0a8f
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ cell2mol: Unit Cell to Molecule Interpretation

## Contents
* [About](#about-)
* [Citation](#citation-)
* [Install](#install-)
* [Examples](#examples-)
* [Errors](#errors-)
Expand Down Expand Up @@ -34,6 +35,14 @@ For portability, we provide an exemplary conda environment in `environment.yml`

Afterwards, the created environment can be activated and the following steps should proceed smoothly. We also provide a `requirements.txt` file that should streamline virtual environment creation with pip, if desired.

## Citation [](#citation)

If you use cell2mol, please cite:

```
Vela, S., Laplaza, R., Cho, Y. et al. cell2mol: encoding chemistry to interpret crystallographic data. npj Comput Mater 8, 188 (2022). https://doi.org/10.1038/s41524-022-00874-9
```

## Install [](#install)

Download and add c2m_driver.py to your path. No strings attached. Run as:
Expand Down

0 comments on commit d8a0a8f

Please sign in to comment.