https://github.com/materialsproject/workshop

The Materials Project Workshop Curriculum
https://github.com/materialsproject/workshop

Last synced: about 1 month ago
JSON representation

The Materials Project Workshop Curriculum

• Host: GitHub
• URL: https://github.com/materialsproject/workshop
• Owner: materialsproject
• License: bsd-3-clause
• Created: 2018-07-25T16:39:01.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-03-01T16:57:33.000Z (about 2 years ago)
• Last Synced: 2025-04-02T10:14:39.957Z (about 2 months ago)
• Language: Jupyter Notebook
• Homepage: https://workshop.materialsproject.org
• Size: 443 MB
• Stars: 114
• Watchers: 13
• Forks: 128
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/materialsproject/workshop/master)

## Materials Project Workshop

Assets for the Materials Project workshop.

*This repository is under development for our 2021 workshop. There may be changes up until the day(s) of the workshop. Click [here](https://github.com/materialsproject/workshop/releases) for a snapshot of the 2020, 2019 and 2018 workshop assets.*

## Building the Documentation

The following command will build the workshop docs:

``` python

pip install -r requirements-docs.txt

python setup.py develop

mkdocs build

```

## Developing

Develop new material in either `jupyter-notebook`s 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.