-
Notifications
You must be signed in to change notification settings - Fork 146
/
README.md
106 lines (85 loc) · 28.6 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
Visit the [Github Pages](http://matgenb.materialsvirtuallab.org) for a nicely formatted HTML page and notebook search functionality.
# Introduction
This repo is started by the [Materials Virtual Lab](http://www.materialsvirtuallab.org) as a useful collection of
Jupyter notebooks that demonstrate the utilization of open-source codes for the study of materials science.
We frequently get requests (from students, postdocs, collaborators, or just general users) for example codes that
demonstrate various capabilities in the open-source software we maintain and contribute to, such as the Materials
Project software stack comprising [Python Materials Genomics (pymatgen)](http://www.pymatgen.org),
[Custodian](https://materialsprojecthub.io/custodian/), and [Fireworks](https://pythonhosted.org/FireWorks/). This
repo is a start at building a more sustainable path towards sharing of code examples.
It is not limited to the codes we develop - any use of open source software for materials analysis is welcome. Also,
anyone is welcome to contribute.
## Running the examples from a browser
| |        |          |         |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **[2013-01-01-Basic functionality](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2013-01-01-Basic%20functionality.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2013-01-01-Basic%20functionality.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2013-01-01-Basic%20functionality.ipynb) |
| **[2013-01-01-Calculating Reaction Energies with the Materials API](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2013-01-01-Calculating%20Reaction%20Energies%20with%20the%20Materials%20API.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2013-01-01-Calculating%20Reaction%20Energies%20with%20the%20Materials%20API.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2013-01-01-Calculating%20Reaction%20Energies%20with%20the%20Materials%20API.ipynb) |
| **[2013-01-01-Calculating XRD patterns](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2013-01-01-Calculating%20XRD%20patterns.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2013-01-01-Calculating%20XRD%20patterns.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2013-01-01-Calculating%20XRD%20patterns.ipynb) |
| **[2013-01-01-Getting crystal structures from online sources](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2013-01-01-Getting%20crystal%20structures%20from%20online%20sources.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2013-01-01-Getting%20crystal%20structures%20from%20online%20sources.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2013-01-01-Getting%20crystal%20structures%20from%20online%20sources.ipynb) |
| **[2013-01-01-Ordering Disordered Structures](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2013-01-01-Ordering%20Disordered%20Structures.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2013-01-01-Ordering%20Disordered%20Structures.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2013-01-01-Ordering%20Disordered%20Structures.ipynb) |
| **[2013-01-01-Plotting and Analyzing a Phase Diagram using the Materials API](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2013-01-01-Plotting%20and%20Analyzing%20a%20Phase%20Diagram%20using%20the%20Materials%20API.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2013-01-01-Plotting%20and%20Analyzing%20a%20Phase%20Diagram%20using%20the%20Materials%20API.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2013-01-01-Plotting%20and%20Analyzing%20a%20Phase%20Diagram%20using%20the%20Materials%20API.ipynb) |
| **[2013-01-01-Plotting the electronic structure of Fe](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2013-01-01-Plotting%20the%20electronic%20structure%20of%20Fe.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2013-01-01-Plotting%20the%20electronic%20structure%20of%20Fe.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2013-01-01-Plotting%20the%20electronic%20structure%20of%20Fe.ipynb) |
| **[2016-09-08-Data-driven First Principles Methods for the Study and Design of](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2016-09-08-Data-driven%20First%20Principles%20Methods%20for%20the%20Study%20and%20Design%20of%20Alkali%20)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2016-09-08-Data-driven%20First%20Principles%20Methods%20for%20the%20Study%20and%20Design%20of%20Alkali%20) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2016-09-08-Data-driven%20First%20Principles%20Methods%20for%20the%20Study%20and%20Design%20of%20Alkali%20) |
| **[2016-09-08-Data-driven First Principles Methods for the Study](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2016-09-08-Data-driven%20First%20Principles%20Methods%20for%20the%20Study%20and%20)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2016-09-08-Data-driven%20First%20Principles%20Methods%20for%20the%20Study%20and%20) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2016-09-08-Data-driven%20First%20Principles%20Methods%20for%20the%20Study%20and%20) |
| **[2016-09-08-Data-driven First Principles Methods for the Study](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2016-09-08-Data-driven%20First%20Principles%20Methods%20for%20the%20Study%20and%20)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2016-09-08-Data-driven%20First%20Principles%20Methods%20for%20the%20Study%20and%20) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2016-09-08-Data-driven%20First%20Principles%20Methods%20for%20the%20Study%20and%20) |
| **[2016-09-25-Plotting phonon bandstructure and dos](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2016-09-25-Plotting%20phonon%20bandstructure%20and%20dos.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2016-09-25-Plotting%20phonon%20bandstructure%20and%20dos.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2016-09-25-Plotting%20phonon%20bandstructure%20and%20dos.ipynb) |
| **[2017-03-02-Getting data from Materials Project](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2017-03-02-Getting%20data%20from%20Materials%20Project.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2017-03-02-Getting%20data%20from%20Materials%20Project.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2017-03-02-Getting%20data%20from%20Materials%20Project.ipynb) |
| **[2017-04-03-Slab generation and Wulff shape](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2017-04-03-Slab%20generation%20and%20Wulff%20shape.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2017-04-03-Slab%20generation%20and%20Wulff%20shape.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2017-04-03-Slab%20generation%20and%20Wulff%20shape.ipynb) |
| **[2017-04-14-Inputs and Analysis of VASP runs](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2017-04-14-Inputs%20and%20Analysis%20of%20VASP%20runs.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2017-04-14-Inputs%20and%20Analysis%20of%20VASP%20runs.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2017-04-14-Inputs%20and%20Analysis%20of%20VASP%20runs.ipynb) |
| **[2017-05-11-Running Jupyter Notebook on clusters](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2017-05-11-Running%20Jupyter%20Notebook%20on%20clusters.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2017-05-11-Running%20Jupyter%20Notebook%20on%20clusters.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2017-05-11-Running%20Jupyter%20Notebook%20on%20clusters.ipynb) |
| **[2017-09-03-Analyze and plot band structures](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2017-09-03-Analyze%20and%20plot%20band%20structures.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2017-09-03-Analyze%20and%20plot%20band%20structures.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2017-09-03-Analyze%20and%20plot%20band%20structures.ipynb) |
| **[2017-12-15-Plotting a Pourbaix Diagram](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2017-12-15-Plotting%20a%20Pourbaix%20Diagram.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2017-12-15-Plotting%20a%20Pourbaix%20Diagram.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2017-12-15-Plotting%20a%20Pourbaix%20Diagram.ipynb) |
| **[2018-01-01-ChemEnv - How to automatically identify coordination environments in a structure](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2018-01-01-ChemEnv%20-%20How%20to%20automatically%20identify%20coordination%20environments%20in%20a%20structure.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2018-01-01-ChemEnv%20-%20How%20to%20automatically%20identify%20coordination%20environments%20in%20a%20structure.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2018-01-01-ChemEnv%20-%20How%20to%20automatically%20identify%20coordination%20environments%20in%20a%20structure.ipynb) |
| **[2018-03-09-Computing the Reaction Diagram between Two Compounds](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2018-03-09-Computing%20the%20Reaction%20Diagram%20between%20Two%20Compounds.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2018-03-09-Computing%20the%20Reaction%20Diagram%20between%20Two%20Compounds.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2018-03-09-Computing%20the%20Reaction%20Diagram%20between%20Two%20Compounds.ipynb) |
| **[2018-03-14-Plotting COHP from LOBSTER](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2018-03-14-Plotting%20COHP%20from%20LOBSTER.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2018-03-14-Plotting%20COHP%20from%20LOBSTER.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2018-03-14-Plotting%20COHP%20from%20LOBSTER.ipynb) |
| **[2018-07-24-Adsorption on solid surfaces](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2018-07-24-Adsorption%20on%20solid%20surfaces.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2018-07-24-Adsorption%20on%20solid%20surfaces.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2018-07-24-Adsorption%20on%20solid%20surfaces.ipynb) |
| **[2018-09-25-Structure Prediction using Pymatgen and the Materials API](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2018-09-25-Structure%20Prediction%20using%20Pymatgen%20and%20the%20Materials%20API.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2018-09-25-Structure%20Prediction%20using%20Pymatgen%20and%20the%20Materials%20API.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2018-09-25-Structure%20Prediction%20using%20Pymatgen%20and%20the%20Materials%20API.ipynb) |
| **[2018-11-6-Dopant suggestions using Pymatgen](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2018-11-6-Dopant%20suggestions%20using%20Pymatgen.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2018-11-6-Dopant%20suggestions%20using%20Pymatgen.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2018-11-6-Dopant%20suggestions%20using%20Pymatgen.ipynb) |
| **[2019-01-04-How to use Boltztrap2 interface](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2019-01-04-How%20to%20use%20Boltztrap2%20interface.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2019-01-04-How%20to%20use%20Boltztrap2%20interface.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2019-01-04-How%20to%20use%20Boltztrap2%20interface.ipynb) |
| **[2019-01-11-How to plot and evaluate output files from Lobster](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2019-01-11-How%20to%20plot%20and%20evaluate%20output%20files%20from%20Lobster.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2019-01-11-How%20to%20plot%20and%20evaluate%20output%20files%20from%20Lobster.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2019-01-11-How%20to%20plot%20and%20evaluate%20output%20files%20from%20Lobster.ipynb) |
| **[2019-03-11-Interface Reactions](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2019-03-11-Interface%20Reactions.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2019-03-11-Interface%20Reactions.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2019-03-11-Interface%20Reactions.ipynb) |
| **[2020-07-15-How to plot a Fermi surface](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2020-07-15-How%20to%20plot%20a%20Fermi%20surface.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2020-07-15-How%20to%20plot%20a%20Fermi%20surface.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2020-07-15-How%20to%20plot%20a%20Fermi%20surface.ipynb) |
| **[2021-08-26-Magnetic Structure Generation as Input for Initial DFT Calculations](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2021-08-26-Magnetic%20Structure%20Generation%20as%20Input%20for%20Initial%20DFT%20Calculations.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2021-08-26-Magnetic%20Structure%20Generation%20as%20Input%20for%20Initial%20DFT%20Calculations.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2021-08-26-Magnetic%20Structure%20Generation%20as%20Input%20for%20Initial%20DFT%20Calculations.ipynb) |
| **[2021-5-12-Explanation of Corrections](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2021-5-12-Explanation%20of%20Corrections.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2021-5-12-Explanation%20of%20Corrections.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2021-5-12-Explanation%20of%20Corrections.ipynb) |
| **[2022-07-23 Interactive Crystal Toolkit Structure Viewer](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2022-07-23%20Interactive%20Crystal%20Toolkit%20Structure%20Viewer.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2022-07-23%20Interactive%20Crystal%20Toolkit%20Structure%20Viewer.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2022-07-23%20Interactive%20Crystal%20Toolkit%20Structure%20Viewer.ipynb) |
| **[2024-06-27 Charge Density Difference](https://github.com/materialsvirtuallab/matgenb/blob/master/notebooks/2024-06-25%20Charge_Density_Difference.ipynb)** | [![Binder]](https://mybinder.org/v2/gh/materialsvirtuallab/matgenb/master?labpath=notebooks/2024-06-27%20Charge_Density_Difference.ipynb) | [![Launch Codespace]][codespace url] | [![Open in Google Colab]](https://colab.research.google.com/github/materialsvirtuallab/matgenb/blob/master/notebooks/2024-06-27%20Charge_Density_Difference.ipynb) |
[Binder]: https://mybinder.org/badge_logo.svg
[Open in Google Colab]: https://colab.research.google.com/assets/colab-badge.svg
[Launch Codespace]: https://img.shields.io/badge/Launch-Codespace-darkblue?logo=github
[codespace url]: https://github.com/codespaces/new?hide_repo_select=true&ref=master&repo=83753201
## Contributing
1. Fork this repo and clone.
```sh
git clone git@github.com:<your_github_username>/matgenb
cd matgenb
```
2. Write a new notebook in the `notebooks` folder.
```sh
cd notebooks
jupyter notebook
```
3. Notebooks should be well-documented and simple. The idea here is to be pedagogical. A newcomer to the software
(with the right materials science background) should be able to follow the logic without too much difficulty. Feel
free to add authorship and contact information, as well as works to cite and acknowledge your contributions. In view
that scientific codes tend to be continuously being updated, please put in a list of the key pinned dependencies so
that other users can install the exact version of software to run the notebook if needed. The best practice is to put
a section that provides a commented out `pip install` command that can be used in Google Colab. For example,
```sh
# Uncomment the subsequent lines in this cell to install dependencies for Google Colab.
# !pip install pymatgen==2022.2.27
```
4. Ideally, please update notebooks as needed to use more modern versions of the codes, and you may update the date of
the notebook as needed.
5. Notebooks should be placed in the `notebooks` folder, and the name should start with the date in
`YYYY-MM-DD-<intuitive title>` format. See [existing examples](https://github.com/materialsvirtuallab/matgenb/tree/master/notebooks). Remember to add it to the [above table](#running-the-examples-from-a-browser) too.
6. In the root folder of the repo, convert the jupyter notebooks to html.
```sh
jupyter nbconvert --to html notebooks/*.ipynb --output-dir docs/_posts
```
7. Commit and push.
```sh
git add .
git commit -a -m "Describe your contribution"
git push
```
8. Submit a pull request from Github.