deploy: f5e1ad8

FAIR-Chem · May 17, 2024 · 88ab3e4 · 88ab3e4
1 parent 4958e1c
commit 88ab3e4
Show file tree

Hide file tree

Showing 269 changed files with 1,760 additions and 11,296 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: b5d0ff58eedd87b93894b95d734e1b60
+config: ac9e52e0f6ce67401b12e91af06590f6
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_downloads/5fdddbed2260616231dbf7b0d94bb665/train.txt b/_downloads/5fdddbed2260616231dbf7b0d94bb665/train.txt
diff --git a/_downloads/819e10305ddd6839cd7da05935b17060/mass-inference.txt b/_downloads/819e10305ddd6839cd7da05935b17060/mass-inference.txt
diff --git a/_images/01e81f6c3f48ab7afff5b938d0c6a052f8635f048b5b7f495a17409cb544df72.png b/_images/01e81f6c3f48ab7afff5b938d0c6a052f8635f048b5b7f495a17409cb544df72.png
diff --git a/_images/170bc9949a589c01b9dd86594314ef1566bd2800215484dd031eacea9d34b8ed.png b/_images/170bc9949a589c01b9dd86594314ef1566bd2800215484dd031eacea9d34b8ed.png
diff --git a/_images/2c4bb26d275ec9417db0b773e5825660c93f048a3876215fe85b70f8c1d94a6e.png b/_images/2c4bb26d275ec9417db0b773e5825660c93f048a3876215fe85b70f8c1d94a6e.png
diff --git a/_images/366dcb1f0d2763d7437d3b5b666ebfda153643d4b11dc71a09f6161ce695c67c.png b/_images/366dcb1f0d2763d7437d3b5b666ebfda153643d4b11dc71a09f6161ce695c67c.png
diff --git a/_images/3af36046407c85efd47c685c029d67f42a28c228c33b7b8a35c33f393440382a.png b/_images/3af36046407c85efd47c685c029d67f42a28c228c33b7b8a35c33f393440382a.png
diff --git a/_images/456ff01f27836e8b343bf8d3891273a557faf080bf9dfd1d82452e352dc0ceea.png b/_images/456ff01f27836e8b343bf8d3891273a557faf080bf9dfd1d82452e352dc0ceea.png
diff --git a/_images/4bace82b10c623914f65162c41715b5dfcc194c1569698d06031d1f715ccc1e4.png b/_images/4bace82b10c623914f65162c41715b5dfcc194c1569698d06031d1f715ccc1e4.png
diff --git a/_images/50c8e6d9d4ff36851865c963e5b0dbec8644e6b8165949be66d93ad908a3a94c.png b/_images/50c8e6d9d4ff36851865c963e5b0dbec8644e6b8165949be66d93ad908a3a94c.png
diff --git a/_images/61a3228be2ca87b7b54934b6abc4e125fb13549b980aec4faca1d062f40cd24e.png b/_images/61a3228be2ca87b7b54934b6abc4e125fb13549b980aec4faca1d062f40cd24e.png
diff --git a/_images/643db0cf71f60bbef7025b3f50dfab282da4371e89979a0744574aaa167e16fc.png b/_images/643db0cf71f60bbef7025b3f50dfab282da4371e89979a0744574aaa167e16fc.png
diff --git a/_images/699a8e28c0e5af6b7d542d532d2dd7a99ceda6c37e0d2fdd9d6c4cbc5eae57ef.png b/_images/699a8e28c0e5af6b7d542d532d2dd7a99ceda6c37e0d2fdd9d6c4cbc5eae57ef.png
diff --git a/_images/6a5800b612d2be5c9576cda60c4f84e52cbeee8ab9c16e8abc25a1c42d77bf2e.png b/_images/6a5800b612d2be5c9576cda60c4f84e52cbeee8ab9c16e8abc25a1c42d77bf2e.png
diff --git a/_images/7578ee45a79d2affcd21d68cf8b06181742c275c2280a7bcc84b98d41b78dc6e.png b/_images/7578ee45a79d2affcd21d68cf8b06181742c275c2280a7bcc84b98d41b78dc6e.png
diff --git a/_images/779c250f6bf7aaa03eef896ef1541e648ebf742911fe25095bde7b712d7234d4.png b/_images/779c250f6bf7aaa03eef896ef1541e648ebf742911fe25095bde7b712d7234d4.png
diff --git a/_images/822098d60fa7a37fab2d8bd60c4eb2550de2ea076f9e6a557642d0776192bde3.png b/_images/822098d60fa7a37fab2d8bd60c4eb2550de2ea076f9e6a557642d0776192bde3.png
diff --git a/_images/88ead5bbd89bc50c23bfe01328aaa56af0a05a83b148ec0823e6f4c10cf0cd88.png b/_images/88ead5bbd89bc50c23bfe01328aaa56af0a05a83b148ec0823e6f4c10cf0cd88.png
diff --git a/_images/8f0c9791161c339543bda4170c3f954270bca8b6e60d88b947cc42c8e7018929.png b/_images/8f0c9791161c339543bda4170c3f954270bca8b6e60d88b947cc42c8e7018929.png
diff --git a/_images/90530c0fb25b9caa530cc02502a659b784f34bf0b8ebdceb934bee7ddc222d55.png b/_images/90530c0fb25b9caa530cc02502a659b784f34bf0b8ebdceb934bee7ddc222d55.png
diff --git a/_images/91047de027f6044074d02e1daa405a2fef563d024b57288137bc0adf4344b0b9.png b/_images/91047de027f6044074d02e1daa405a2fef563d024b57288137bc0adf4344b0b9.png
diff --git a/_images/94b675b655200519baaacdd72a4fb6b0f7a36c57d7a4025b34de029233d8d3f8.png b/_images/94b675b655200519baaacdd72a4fb6b0f7a36c57d7a4025b34de029233d8d3f8.png
diff --git a/_images/bafcd798ce6fa792883069f5f67d59f84f0614aee01a6b563e2eda73664e980d.png b/_images/bafcd798ce6fa792883069f5f67d59f84f0614aee01a6b563e2eda73664e980d.png
diff --git a/_images/bc678ad5f054a187ada9488eac6034ec451475c82b447ad813ae1b9b24601637.png b/_images/bc678ad5f054a187ada9488eac6034ec451475c82b447ad813ae1b9b24601637.png
diff --git a/_images/cc229e2a633750ac5877c208b790eeda77e4e79be782b51ff8c987874d8977ae.png b/_images/cc229e2a633750ac5877c208b790eeda77e4e79be782b51ff8c987874d8977ae.png
diff --git a/_images/d2caa281738a05cfd6c4e7574edac628bc5183711e03f77721b068ff904c66d3.png b/_images/d2caa281738a05cfd6c4e7574edac628bc5183711e03f77721b068ff904c66d3.png
diff --git a/_images/dd5a6f98208aaa1c5ff0b1c91baebe0a2cd7bc24bdda4bc2cd0905198d1021e9.png b/_images/dd5a6f98208aaa1c5ff0b1c91baebe0a2cd7bc24bdda4bc2cd0905198d1021e9.png
diff --git a/_images/e407f2aba16854949ec326b5ce84fc620bea274782085e3f1bb89ccfb4f910f0.png b/_images/e407f2aba16854949ec326b5ce84fc620bea274782085e3f1bb89ccfb4f910f0.png
diff --git a/_images/eea5906a9c28d160b736caf478f8c2a9eee7eb06c0b3c513bffbf9b5489f03f1.png b/_images/eea5906a9c28d160b736caf478f8c2a9eee7eb06c0b3c513bffbf9b5489f03f1.png
diff --git a/_sources/core/install.md b/_sources/core/install.md
@@ -1,12 +1,13 @@
 # Installation
-
-To install `fairchem-core` you will need to setup the `fairchem-core` environment (using [conda](#Conda) or [pip](#PyPi)) and then either install `fairchem-core` package [directly](#Install-fairchem-core) or install [development version](#Development-install) from our git repository.
 
-## Environment 
+To install `fairchem-core` you will need to setup the `fairchem-core` environment (using [conda](#Conda) or [pip](#PyPi))
+and then either install `fairchem-core` package [directly](#Install-fairchem-core) or install a [development version](#Development-install) from our git repository.
+
+## Environment
 
 You can install the environment using either conda or pip
 
-### Conda 
+### Conda
 
 We do not have official conda recipes (yet!); in the meantime you can use the
 following environment yaml files to setup on CPU or GPU. If conda is too slow for you, please consider using [mamba](https://mamba.readthedocs.io/en/latest/user_guide/mamba.html)
@@ -59,9 +60,8 @@ pip install fairchem-{package-to-install}
 
 ## Development install
 
-If you plan to make contributions you will need to fork and clone (for windows user please see next section) the repo, set up the environment, and install from source.
-`fairchem-core` in editable mode with dev
-dependencies,
+If you plan to make contributions you will need to fork and clone (for windows user please see next section) the repo,
+set up the environment, and install fairchem-core from source in editable mode with dev dependencies,
 ```bash
 git clone https://github.com/FAIR-Chem/fairchem.git
 cd fairchem

diff --git a/_sources/index.md b/_sources/index.md
@@ -1,4 +1,5 @@
-<h1 align="center"> <code>fairchem</code> by FAIR Chemistry </h1>
+
+<h2 align="center"> <code>fairchem</code> by FAIR Chemistry </h2>
 
 <p align="center">
   <img width="559" height="200" src="https://github.com/FAIR-Chem/fairchem/assets/45150244/5872c21c-8f39-41af-b703-af9817f0affe"?
@@ -11,6 +12,8 @@
 
 </h4>
 
+#### FAIR-Chem overview
+
 `fairchem` is the [FAIR](https://ai.meta.com/research/) Chemistry's centralized repository of all its data, models, demos, and application efforts
 for materials science and quantum chemistry. Collaborative projects that contribute or use the models and approaches in
 this repo:
@@ -22,7 +25,7 @@ We re-organized and rebranded the repository in 2024 (previously the `fairchem`
 general usability of these models beyond catalysis, including things like direct air capture.
 ```
 
-### Datasets in `fairchem`:
+#### Datasets in `fairchem`:
 `fairchem` provides training and evaluation code for tasks and models that take arbitrary
 chemical structures as input to predict energies / forces / positions / stresses,
 and can be used as a base scaffold for research projects. For an overview of
@@ -33,7 +36,7 @@ tasks, data, and metrics, please read the documentations and respective papers:
  - [OC20Dense](core/datasets/oc20dense)
  - [OC20NEB](core/datasets/oc20neb)
 
-### Projects and models built on `fairchem`:
+#### Projects and models built on `fairchem`:
 
 - SchNet [[`arXiv`](https://arxiv.org/abs/1706.08566)] [[`code`](https://github.com/FAIR-Chem/fairchem/blob/main/src/fairchem/core/models/schnet.py)]
 - DimeNet++ [[`arXiv`](https://arxiv.org/abs/2011.14115)] [[`code`](https://github.com/FAIR-Chem/fairchem/blob/main/src/fairchem/core/models/dimenet_plus_plus.py)]
@@ -53,15 +56,15 @@ Older model implementations that are no longer supported:
 - SpinConv [[`arXiv`](https://arxiv.org/abs/2106.09575)] [[`code`](https://github.com/FAIR-Chem/fairchem/blob/e7a8745eb307e8a681a1aa9d30c36e8c41e9457e/ocpmodels/models/spinconv.py)]
 - ForceNet [[`arXiv`](https://arxiv.org/abs/2103.01436)] [[`code`](https://github.com/FAIR-Chem/fairchem/blob/e7a8745eb307e8a681a1aa9d30c36e8c41e9457e/ocpmodels/models/forcenet.py)]
 
-## Discussion
+### Discussion
 
 For all non-codebase related questions and to keep up-to-date with the latest OCP
 announcements, please join the [discussion board](https://discuss.opencatalystproject.org/).
 
 All code-related questions and issues should be posted directly on our
 [issues page](https://github.com/FAIR-Chem/fairchem/issues).
 
-## Acknowledgements
+### Acknowledgements
 
 - This codebase was initially forked from [CGCNN](https://github.com/txie-93/cgcnn)
 by [Tian Xie](http://txie.me), but has undergone significant changes since.
@@ -70,11 +73,11 @@ by [Tian Xie](http://txie.me), but has undergone significant changes since.
 - It was then developed as the OCP repo, and includes many contributions from the community and collaborators.
 - Much of the documentation was developed for various papers or as part of a comprehensive tutorial for the 2023 ACS Fall Chemistry conference.
 
-## License
+### License
 
 `fairchem` is released under the [MIT](https://github.com/FAIR-Chem/fairchem/blob/main/LICENSE.md) license.
 
-## Citing `fairchem`
+### Citing `fairchem`
 
 If you use this codebase in your work, please consider citing:
 

diff --git a/_static/logo.png b/_static/logo.png
diff --git a/autoapi/adsorbml/2023_neurips_challenge/challenge_eval/index.html b/autoapi/adsorbml/2023_neurips_challenge/challenge_eval/index.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>adsorbml.2023_neurips_challenge.challenge_eval &#8212; FAIR Chemistry Documentation</title>
+    <title>adsorbml.2023_neurips_challenge.challenge_eval</title>
 
 
 
@@ -146,14 +146,8 @@
 
 
 
-
-
-
-
-
-    <img src="../../../../_static/logo.png" class="logo__image only-light" alt="FAIR Chemistry Documentation - Home"/>
-    <script>document.write(`<img src="../../../../_static/logo.png" class="logo__image only-dark" alt="FAIR Chemistry Documentation - Home"/>`);</script>
 
+    <p class="title logo__title"></p>
 
 </a></div>
         <div class="sidebar-primary-item">
@@ -173,7 +167,7 @@
         <ul class="nav bd-sidenav bd-sidenav__home-link">
             <li class="toctree-l1">
                 <a class="reference internal" href="../../../../index.html">
-                    Datasets in fairchem:
+                    FAIR-Chem overview
                 </a>
             </li>
         </ul>

diff --git a/autoapi/adsorbml/scripts/dense_eval/index.html b/autoapi/adsorbml/scripts/dense_eval/index.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>adsorbml.scripts.dense_eval &#8212; FAIR Chemistry Documentation</title>
+    <title>adsorbml.scripts.dense_eval</title>
 
 
 
@@ -146,14 +146,8 @@
 
 
 
-
-
-
-
-
-    <img src="../../../../_static/logo.png" class="logo__image only-light" alt="FAIR Chemistry Documentation - Home"/>
-    <script>document.write(`<img src="../../../../_static/logo.png" class="logo__image only-dark" alt="FAIR Chemistry Documentation - Home"/>`);</script>
 
+    <p class="title logo__title"></p>
 
 </a></div>
         <div class="sidebar-primary-item">
@@ -173,7 +167,7 @@
         <ul class="nav bd-sidenav bd-sidenav__home-link">
             <li class="toctree-l1">
                 <a class="reference internal" href="../../../../index.html">
-                    Datasets in fairchem:
+                    FAIR-Chem overview
                 </a>
             </li>
         </ul>

diff --git a/autoapi/adsorbml/scripts/process_mlrs/index.html b/autoapi/adsorbml/scripts/process_mlrs/index.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>adsorbml.scripts.process_mlrs &#8212; FAIR Chemistry Documentation</title>
+    <title>adsorbml.scripts.process_mlrs</title>
 
 
 
@@ -146,14 +146,8 @@
 
 
 
-
-
-
-
-
-    <img src="../../../../_static/logo.png" class="logo__image only-light" alt="FAIR Chemistry Documentation - Home"/>
-    <script>document.write(`<img src="../../../../_static/logo.png" class="logo__image only-dark" alt="FAIR Chemistry Documentation - Home"/>`);</script>
 
+    <p class="title logo__title"></p>
 
 </a></div>
         <div class="sidebar-primary-item">
@@ -173,7 +167,7 @@
         <ul class="nav bd-sidenav bd-sidenav__home-link">
             <li class="toctree-l1">
                 <a class="reference internal" href="../../../../index.html">
-                    Datasets in fairchem:
+                    FAIR-Chem overview
                 </a>
             </li>
         </ul>

diff --git a/autoapi/adsorbml/scripts/utils/index.html b/autoapi/adsorbml/scripts/utils/index.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>adsorbml.scripts.utils &#8212; FAIR Chemistry Documentation</title>
+    <title>adsorbml.scripts.utils</title>
 
 
 
@@ -146,14 +146,8 @@
 
 
 
-
-
-
-
-
-    <img src="../../../../_static/logo.png" class="logo__image only-light" alt="FAIR Chemistry Documentation - Home"/>
-    <script>document.write(`<img src="../../../../_static/logo.png" class="logo__image only-dark" alt="FAIR Chemistry Documentation - Home"/>`);</script>
 
+    <p class="title logo__title"></p>
 
 </a></div>
         <div class="sidebar-primary-item">
@@ -173,7 +167,7 @@
         <ul class="nav bd-sidenav bd-sidenav__home-link">
             <li class="toctree-l1">
                 <a class="reference internal" href="../../../../index.html">
-                    Datasets in fairchem:
+                    FAIR-Chem overview
                 </a>
             </li>
         </ul>