Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dandavies99 committed Apr 16, 2020
1 parent 40f2e6f commit 3b35733
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Background
This repository accompanies the publication XYZ.
This repository accompanies the publication **_Low-cost Descriptors of Electrostatic and Electronic Contributions to Anion Redox Activity in Batteries_**.

# Inventory
**[Notebook 1: Classical Electrostatic Analysis](https://github.com/FaradayInstitution/redox_descriptors/blob/master/Notebooks/Notebook_1-madelung_analysis.ipynb)**
Expand All @@ -23,3 +23,6 @@ This repository accompanies the publication XYZ.
- config files for sumo DOS plotting code (`custom_colors.conf`, `custom.mplstyle`).
- `matplotlibrc` - Matplotlib config file used to generate plots (set `text.usetex: False` if LaTeX not installed).

# Requirements
To run the jupyter notebooks, you will need the Python packages Scipy, Numpy, Matplotlib and Pymatgen. Pymatgen depends on the rest so just `pip install pymatgen`.

0 comments on commit 3b35733

Please sign in to comment.