Visit the Github Pages for a nicely formatted HTML page and notebook search functionality.
This repo is started by the Materials Virtual Lab 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), Custodian, and 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.
- Fork this repo and clone.
git clone email@example.com:m<your_github_username>/matgenb.git cd matgenb
- Write a new notebook in the
cd notebooks jupyter notebook
- 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. 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. An example preamble can be:
This notebook demonstrates the core functionality in pymatgen for manipulating structures. Written with:
- Notebooks should be placed in the
notebooksfolder, and the name should start with the date in
YYYY-MM-DD-<intuitive title>format. See existing examples.
- In the root folder of the repo, convert the jupyter notebooks to html.
jupyter nbconvert --to html notebooks/*.ipynb --output-dir docs/_posts
- Commit and push.
git add . git commit -a -m "Describe your contribution" git push
- Submit a pull request from Github.