Skip to content

About

Forge is the Python package to access data in the Materials Data Facility

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Forge

Build Status PyPI

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 .

Examples

from mdf_forge.forge import Forge

mdf = Forge()

# free text query
r = mdf.search("materials commons")

# structured query
r_2 = mdf.search_by_elements(elements=["Al","Cu"], sources=["oqmd"])

More examples are available in the examples directory.

Documentation

Documentation is available in the docs directory.

Requirements

  • Forge requires Python 3
  • 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).

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".

About

Forge is the Python package to access data in the Materials Data Facility

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages