Skip to content

Commit 24d701e

Browse files
author
jgaff
committed
Doc fixes
1 parent 5b607e8 commit 24d701e

2 files changed

Lines changed: 4 additions & 21 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,8 @@ cd forge
1616
pip install -e .
1717
```
1818

19-
# Examples
20-
21-
```python
22-
from mdf_forge.forge import Forge
23-
24-
mdf = Forge()
25-
26-
# free text query
27-
r = mdf.search("materials commons")
28-
29-
# structured query
30-
r_2 = mdf.search_by_elements(elements=["Al","Cu"], sources=["oqmd"])
31-
```
32-
33-
More examples are available in the docs/examples directory.
34-
35-
36-
# Documentation
37-
Documentation is available in the docs directory.
19+
# Documentation and examples
20+
Documentation, including tutorials and examples, can be found in the `docs` directory.
3821

3922
# Requirements
4023
* Forge requires Python 2.7 or >=3.3

‎docs/tutorials/6 - Data Retrieval Functions.ipynb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
"\n",
3535
"In order to use `globus_download()` to download to your computer, you must be running [Globus Connect Personal](https://www.globus.org/app/endpoints/create-gcp) . If you want to download to a different computer (which must be a Globus Endpoint), you have to specify `dest_ep=ID_of_destination_endpoint`.\n",
3636
"\n",
37-
"Please note that while _almost_ all data in MDF is accessible through a Globus Endpoint, there may be some entries that are not. A few datasets may be hosted elsewhere and only accessible through HTTP (see `http_download()`) or hosted elsewhere in a custom, non-programmatic configuration. You may have to use the `\"mdf.links.landing_page\"` web address to fetch these datasets."
37+
"Please note that while _almost_ all data in MDF is accessible through a Globus Endpoint, there may be some entries that are not. A few datasets may be hosted elsewhere and only accessible through HTTP (see `http_download()`) or hosted elsewhere in a custom, non-programmatic configuration."
3838
]
3939
},
4040
{
@@ -44,7 +44,7 @@
4444
"outputs": [],
4545
"source": [
4646
"# Running this example will save a file in the current directory.\n",
47-
"res = mdf.search(\"dft.converged:true AND mdf.resource_type:record\", limit=1)\n",
47+
"res = mdf.search(\"dft.converged:true AND mdf.resource_type:record\", limit=10)\n",
4848
"mdf.globus_download(res)"
4949
]
5050
},

0 commit comments

Comments
 (0)