README.md

Examples for the MADAS code

This repository contains examples for the paper:

MADAS: A Python framework for assessing similarity in materials-science data
Martin Kuban, Santiago Rigamonti, and Claudia Draxl
preprint, arXiv:2403.10470 (2024)

Installation

Please execute:

pip install -r requirements.txt

Usage

To execute the examples, run:

jupyter notebook

and open the notebooks in the folder notebooks.

Alternatively, you can generate a pdf version via:

jupyter nbconvert --to pdf --execute notebooks/*.ipynb

Notes

To run the notebook: "comparing_web_databases_volumes.ipynb", please set an environmental variable with your API access key for the Materials Project database before starting Jupyter:

export MP_API_KEY=<YOUR_KEY>