docs's Introduction

Materials Project Documentation

!!! warning Migration of content from our wiki (https://www.materialsproject.org/wiki) is underway. Until this notice is removed, please go there (or use documentation links on https://materialsproject.org/) for up-to-date documentation.

This is a place for all documentation relating to the Materials Project (MP), encompassing:

Foundations: concepts in materials and computer science that structure and aid interpretation of our data sets
Case Studies: Examples of materials analysis and design using our data and tools
Productivity: Using our website, application programming interface (API), and codebases.
Reproducibility: How we generate and validate our computed data sets
Contribution: Developer guides and design specifications

If you notice an error or omission, please post an issue or suggest an edit to us via a Pull Request.

Thanks,
Materials Project Team

Contributing

We use MkDocs, a static site generator for project documentation. We also use the mkdocs-material theme for styling.

Up and running

Fork this repository and then clone it to your computer.

Create a Python 3 environment for this project and activate it. Example flow using conda:

$ conda create -n mpdocs python=3
$ conda activate mpdocs

Navigate to the folder of your cloned repository, and install dependencies:

(mpdocs)$ pip install -r requirements.txt

Start the development server:

(mpdocs)$ mkdocs serve

Open http://127.0.0.1:8000/ to preview the site and see changes as you make them.

Create a new git branch to record any changes. When you push your branch to GitHub, you can then initiate a Pull Request against the master branch of this repo.

Recommend Projects