Skip to content

Commit 1017052

Browse files
author
jgaff
committed
Refactor examples and tutorials
Examples have been split into docs/tutorials/ and examples/ and have been refactored.
1 parent 2e63c93 commit 1017052

81 files changed

Lines changed: 2757 additions & 21029 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/Forge_Quickstart.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Forge Quickstart Guide
22
## Install Forge
3-
The first step is to install Forge. Detailed instructions are available in the [Installation Guide](./Installation_Guide.md) . You only need to install Forge.
3+
The first step is to install Forge. Detailed instructions are available in the [Installation Guide](./Installation_Guide.md) . The "pip" method is recommended.
44

55
## Import Forge
66
Once Forge is installed, it is available for your Python scripts or Jupyter notebooks.

‎docs/Installation_Guide.md‎

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -25,23 +25,3 @@ Finally, use `pip` to install Forge:
2525
pip3 install -e .
2626
```
2727

28-
29-
# Refinery Installation
30-
Please note that Refinery is designed for ingesting data into MDF. Refinery is *not* required to access or search data in MDF.
31-
## Via GitHub
32-
You will need to have git, Python 3, and pip to install Refinery via GitHub.
33-
Start by following the instructions above to install Forge via GitHub.
34-
```bash
35-
git clone https://github.com/materials-data-facility/forge.git
36-
cd forge
37-
pip3 install -e .
38-
```
39-
Then, enter the `refinery` directory:
40-
```bash
41-
cd ..
42-
cd refinery
43-
```
44-
Finally, use `pip` to install Refinery:
45-
```bash
46-
pip3 install -e .
47-
```

‎docs/MDF Metadata Schemas.txt‎

Lines changed: 0 additions & 140 deletions
This file was deleted.

‎docs/Makefile‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎docs/_build/.buildinfo‎

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎docs/_build/.doctrees/conf.doctree‎

-3.03 KB
Binary file not shown.
-1.28 MB
Binary file not shown.
-4.65 KB
Binary file not shown.
-139 KB
Binary file not shown.
-2.49 KB
Binary file not shown.

0 commit comments

Comments
 (0)