Forge is the Python package to access data in the Materials Data Facility
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
mdf_forge
tests
.coveragerc
.gitignore
.travis.yml
LICENSE
NOTICE
README.md
requirements.txt
setup.cfg
setup.py
test_requirements.txt
travis.tar.enc

README.md

Forge

PyPI Build Status Coverage Status Read the Docs

Forge is the Materials Data Facility Python package to interface and leverage the MDF Data Discovery service. Forge allows users to perform simple queries and facilitiates moving and synthesizing results.

Installation

pip install mdf_forge

For Developers

git clone https://github.com/materials-data-facility/forge.git
cd forge
pip install -e .

Documentation and examples

Forge documentation can be found on Read the Docs. Tutorials and examples can be found in the docs directory. The Jupyter notebooks can be viewed on GitHub or run interactively with Jupyter.

Requirements

  • Forge requires Python 3.5 or greater.
  • To access data in the MDF, you must have an account recognized by Globus Auth (including Google, ORCiD, many academic institutions, or a free Globus ID).

Contributions

If you find a bug or want a feature, feel free to open an issue here on GitHub (and please tag it accordingly). If you want to contribute code yourself, we're more than happy to accept merge requests.

Support

This work was performed under financial assistance award 70NANB14H012 from U.S. Department of Commerce, National Institute of Standards and Technology as part of the Center for Hierarchical Material Design (CHiMaD). This work was also supported by the National Science Foundation as part of the Midwest Big Data Hub under NSF Award Number: 1636950 "BD Spokes: SPOKE: MIDWEST: Collaborative: Integrative Materials Design (IMaD): Leverage, Innovate, and Disseminate".