Skip to content

Commit

Permalink
GITBOOK-65: testing versioning release
Browse files Browse the repository at this point in the history
  • Loading branch information
kjschmidt913 authored and gitbook-bot committed Mar 21, 2024
1 parent daa9250 commit 54e771f
Show file tree
Hide file tree
Showing 5 changed files with 110 additions and 109 deletions.
Binary file modified docs/.gitbook/assets/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 25 additions & 9 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
# Introduction and Installation
# Getting started with Foundry

<figure><img src=".gitbook/assets/foundry-logo-new.png" alt=""><figcaption></figcaption></figure>
![](.gitbook/assets/foundry-purple.png)

## What is Foundry?

Foundry is a Python package that simplifies the discovery and usage of machine-learning ready datasets in materials science and chemistry. We provide software tools that make it easy to load datasets and work with them in local or cloud environments.&#x20;

**Capability Status:** Researchers can contribute by publishing new [datasets](publishing/publishing-datasets.md) through a self-service publication process. Our dataset capabilities are currently in **production.**
Foundry is a Python package that simplifies the discovery and usage of machine-learning ready datasets in materials science and chemistry. Foundry provides software tools that make it easy to load these datasets and work with them in local or cloud environments. Further, Foundry provides a dataset specification, and defined curation flows, that allow users to create new datasets for the community to use through this same interface.

## Installation

Expand All @@ -16,11 +14,29 @@ Foundry can be installed on any operating system with Python with pip
pip install foundry-ml
```

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td></td><td>Use Datasets</td><td></td><td><a href="loading-and-using/examples.md">examples.md</a></td><td><a href=".gitbook/assets/foundry-down.png">foundry-down.png</a></td></tr><tr><td></td><td>Publish Datasets</td><td></td><td><a href="publishing/publishing-datasets.md">publishing-datasets.md</a></td><td><a href=".gitbook/assets/foundry-up.png">foundry-up.png</a></td></tr></tbody></table>

### Globus

We use the Globus platform for authentication and optimization of some data transfer operations. Follow the steps below to get set up.
Foundry uses the Globus platform for authentication, search, and to optimize some data transfer operations. Follow the steps below to get set up.

* [Create a free account.](https://app.globus.org) You can create a free account here with your institutional credentials or with free IDs (GlobusID, Google, ORCID, etc).
* [Set up a Globus Connect Personal endpoint ](https://www.globus.org/globus-connect-personal)_**(optional)**_. While this step is optional, some Foundry capabilities will work more efficiently when using Globus Connect Personal (GCP).
* [Set up a Globus Connect Personal endpoint ](https://www.globus.org/globus-connect-personal)_**(optional)**_. While this step is optional, some Foundry capabilities will work more efficiently when using GCP.

## Project Support

This work was supported by the National Science Foundation under NSF Award Number: 1931306 "Collaborative Research: Framework: Machine Learning Materials Innovation Infrastructure".

### Other Support

Foundry brings together many components in the materials data ecosystem. Including MAST-ML, the Data and Learning Hub for Science (DLHub), and The Materials Data Facility (MDF).

#### MAST-ML

This work was supported by the National Science Foundation (NSF) SI2 award No. 1148011 and DMREF award number DMR-1332851

#### The Data and Learning Hub for Science (DLHub)

This material is based upon work supported by Laboratory Directed Research and Development (LDRD) funding from Argonne National Laboratory, provided by the Director, Office of Science, of the U.S. Department of Energy under Contract No. DE-AC02-06CH11357. [https://www.dlhub.org](https://www.dlhub.org)

#### The Materials Data Facility

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 performed under the following financial assistance award 70NANB19H005 from U.S. Department of Commerce, National Institute of Standards and Technology as part of the Center for Hierarchical Materials Design (CHiMaD). 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". [https://www.materialsdatafacility.org](https://www.materialsdatafacility.org)
30 changes: 4 additions & 26 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,13 @@
# Table of contents

* [Introduction and Installation](README.md)
* [About Foundry-ML](overview.md)

## Loading and Using

* [Using Datasets](loading-and-using/examples.md)

## Publishing

* [Describing Datasets](publishing/describing-datasets.md)
* [Publishing Datasets](publishing/publishing-datasets.md)

## Advanced Usage

* [Methods](advanced-usage/methods.md)
* [Getting started with Foundry](README.md)

## How to contribute

* [Contribution Process](how-to-contribute/contributing.md)
* [Contributor Covenant](how-to-contribute/code\_of\_conduct.md)

## Support

* [Troubleshooting](support/troubleshooting.md)
* [Project Support](support/project-support.md)

## Under Development
***

* [Command Line Interface (CLI)](under-development/command-line-interface.md)
* [Foundry Benchmarks](under-development/foundry-benchmarks.md)
* [Foundry Data Environments](under-development/foundry-data-environments.md)
* [Foundry Models and Functions](under-development/foundry-models-and-functions.md)
* [Publishing Models](under-development/publishing-models.md)
* [Sphinx Autogenerated documentation - markdown](sphinx-autogenerated-documentation.md)
* [foundry package — Foundry\_test 1.1 documentation - HTML AUTOGENERATION](foundry-package-foundry\_test-1.1-documentation-html-autogeneration.md)
Loading

0 comments on commit 54e771f

Please sign in to comment.