jdagdelen / workshop

Assets for the 2018 Materials Project workshop

Materials Project Workshop

Assets for the Materials Project workshop.

This repository is under development for our 2020 workshop. There may be changes up until the day(s) of the workshop. Click here for a snapshot of the 2019 and 2018 workshop assets.

Building the Documentation

The following command will build the workshop docs:

pip install -r requirements-docs.txt
python setup.py develop
mkdocs build

Developing

Develop new material in either jupyter-notebooks or Markdown documents in the workshop folder. Any data that needs to be preloaded for use in the notebooks should be kept in the python_module or kept locally in the lesson folder if it will be loaded as part of the lesson progress.

Please run pre-commit run -a before commiting new material to ensure it is properly formatted and cleaned of any problematic metadata such as kernel name in the Jupyter Notebook.