Documentation

Here we document all aspects of the code.


Overview

PM allows one to compute various electronic and phononic properties of crystals.

Installation

How you can obtain and install PM.

Docsy Documentation

How to contribute to the documentation of PM.

Command Line Functionality

Executing core functionality of PM from the command line.

Modules

Documenting key classes and functions in each module.

Data Management

How PM handles data that it intakes and generates.

Unit Testing

Unit testing PM.

API References

API References for Principia Materia package