Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
blaiszik authored Aug 31, 2017
1 parent 114e649 commit 9f5660a
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Forge
Forge is the Materials Data Facility Python package to interface and leverage the MDF Data Discovery service.

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](https://www.globusid.org/create)).
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
```
Expand All @@ -13,15 +11,15 @@ pip install -e .
# Examples

```python
from mdf_forge import forge
from mdf_forge.forge import Forge

mdf = forge.Forge()
mdf = Forge()

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

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

More examples are available in the examples directory.
Expand All @@ -30,6 +28,11 @@ 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](https://www.globusid.org/create)).



# 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)](http://chimad.northwestern.edu). This work was also supported by the National Science Foundation as part of the [Midwest Big Data Hub](http://midwestbigdatahub.org) under NSF Award Number: 1636950 "BD Spokes: SPOKE: MIDWEST: Collaborative: Integrative Materials Design (IMaD): Leverage, Innovate, and Disseminate".
Expand Down

0 comments on commit 9f5660a

Please sign in to comment.