What is Emmet

Emmet is a toolkit of packages designed to build the Materials API. The Materials API is the specification of the Materials Project (MP) for defining and dissemenating "materials documents". The core document definitions live in emmet-core. The data pipelines that build these documents live in emmet-builders. A specialized multi-functional CLI to manage the orchestration of calculation ingestion, backup, and parsing is in emmet-cli. Emmet has been developed by the Materials Project team at Lawrence Berkeley Labs.

Emmet is written in Python and supports Python 3.6+.

Emmet fully supports Optimade API and allows your MP infrastructure data to be exposed under the Optimade spec. It is also internally used to serve the MP public Optimade endpoint.

Installation from PyPI

Emmet is a toolkit. Due to a refactoring, emmet is in alpha status with no published metapackage. Only emmet-core is published on the Python Package Index. The preferred tool for installing packages from PyPi is pip. This tool is provided with all modern versions of Python.

Open your terminal and run the following command.

pip install --upgrade emmet-core

Installation from source

You can install Maggma directly from a clone of the Git repository. This can be done either by cloning the repo and installing from the local clone, or simply installing directly via git.

shell tab="Local Clone" git clone https://github.com/materialsproject/emmet cd emmet pip install -e emmet-core/