Emmet

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 functions that transform raw calculation data into these documents live in emmet-builders, and the API server that serves them lives in emmet-api. Emmet has been developed by the Materials Project team at Lawrence Berkeley Labs.

Emmet is written in Python and supports Python 3.11+.

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 with no published metapackage. Each component is published separately on the Python Package Index: emmet-core, emmet-builders, and emmet-api. The preferred tool for installing packages from PyPI is pip. This tool is provided with all modern versions of Python.

Open your terminal and install the packages you need, for example:

pip install --upgrade emmet-core emmet-builders

Installation from source

You can install Emmet directly from a clone of the Git repository. Each package lives in its own subdirectory and is installed individually.

git clone https://github.com/materialsproject/emmet
cd emmet
pip install -e emmet-core/
pip install -e emmet-builders/