Skip to content

Commit

Permalink
deploy: 1e4b1c3
Browse files Browse the repository at this point in the history
  • Loading branch information
zulissimeta committed Apr 11, 2024
1 parent 82ff9ea commit 786b862
Show file tree
Hide file tree
Showing 163 changed files with 177 additions and 4 deletions.
11 changes: 9 additions & 2 deletions _sources/core/QUICKSTART.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,23 @@ Quickstart simulation using pre-trained models

1. First, install OCP in a fresh python environment using one of the approaches in [installation documentation](INSTALL).
2. See what pre-trained potentials are available

```{code-cell} ipython3
from ocpmodels.models.model_registry import available_pretrained_models
print(available_pretrained_models)
```

3. Choose a checkpoint you want to use and download it automatically! We'll use the GemNet-OC potential, trained on both the OC20 and OC22 datasets.

```{code-cell} ipython3
from ocpmodels.models.model_registry import model_name_to_local_file
checkpoint_path = model_name_to_local_file('GemNet-OC OC20+OC22', local_cache='/tmp/ocp_checkpoints/')
checkpoint_path
```

4. Finally, use this checkpoint in an ASE calculator for a simple relaxation!
```

```{code-cell} ipython3
from ocpmodels.common.relaxation.ase_utils import OCPCalculator
from ase.build import fcc111, add_adsorbate
from ase.optimize import BFGS
Expand All @@ -52,4 +57,6 @@ plot_atoms(slab, axs[0]);
plot_atoms(slab, axs[1], rotation=('-90x'))
axs[0].set_axis_off()
axs[1].set_axis_off()
```
```

To learn more about what this simulation means and how it fits into catalysis, see the [catalysis tutorial](tutorials/intro)!
1 change: 1 addition & 0 deletions autoapi/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../core/LICENSE.html">License</a></li>
Expand Down
1 change: 1 addition & 0 deletions autoapi/ocpmodels/common/data_parallel/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/LICENSE.html">License</a></li>
Expand Down
1 change: 1 addition & 0 deletions autoapi/ocpmodels/common/distutils/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/LICENSE.html">License</a></li>
Expand Down
1 change: 1 addition & 0 deletions autoapi/ocpmodels/common/flags/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/LICENSE.html">License</a></li>
Expand Down
1 change: 1 addition & 0 deletions autoapi/ocpmodels/common/gp_utils/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/LICENSE.html">License</a></li>
Expand Down
1 change: 1 addition & 0 deletions autoapi/ocpmodels/common/hpo_utils/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/LICENSE.html">License</a></li>
Expand Down
1 change: 1 addition & 0 deletions autoapi/ocpmodels/common/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../core/LICENSE.html">License</a></li>
Expand Down
1 change: 1 addition & 0 deletions autoapi/ocpmodels/common/logger/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/LICENSE.html">License</a></li>
Expand Down
1 change: 1 addition & 0 deletions autoapi/ocpmodels/common/registry/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/LICENSE.html">License</a></li>
Expand Down
1 change: 1 addition & 0 deletions autoapi/ocpmodels/common/relaxation/ase_utils/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../core/LICENSE.html">License</a></li>
Expand Down
1 change: 1 addition & 0 deletions autoapi/ocpmodels/common/relaxation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/LICENSE.html">License</a></li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../core/LICENSE.html">License</a></li>
Expand Down
1 change: 1 addition & 0 deletions autoapi/ocpmodels/common/relaxation/optimizers/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../core/LICENSE.html">License</a></li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../../core/LICENSE.html">License</a></li>
Expand Down
1 change: 1 addition & 0 deletions autoapi/ocpmodels/common/transforms/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/LICENSE.html">License</a></li>
Expand Down
1 change: 1 addition & 0 deletions autoapi/ocpmodels/common/tutorial_utils/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/LICENSE.html">License</a></li>
Expand Down
1 change: 1 addition & 0 deletions autoapi/ocpmodels/common/typing/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/LICENSE.html">License</a></li>
Expand Down
1 change: 1 addition & 0 deletions autoapi/ocpmodels/common/utils/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/LICENSE.html">License</a></li>
Expand Down
1 change: 1 addition & 0 deletions autoapi/ocpmodels/datasets/_utils/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/LICENSE.html">License</a></li>
Expand Down
1 change: 1 addition & 0 deletions autoapi/ocpmodels/datasets/ase_datasets/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/LICENSE.html">License</a></li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../core/LICENSE.html">License</a></li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../core/LICENSE.html">License</a></li>
Expand Down
1 change: 1 addition & 0 deletions autoapi/ocpmodels/datasets/embeddings/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/LICENSE.html">License</a></li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../core/LICENSE.html">License</a></li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../core/LICENSE.html">License</a></li>
Expand Down
1 change: 1 addition & 0 deletions autoapi/ocpmodels/datasets/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../core/LICENSE.html">License</a></li>
Expand Down
1 change: 1 addition & 0 deletions autoapi/ocpmodels/datasets/lmdb_database/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Quickstart &amp; Installation</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference external" href="https://open-catalyst.metademolab.com/">OCP Demo (no install required!)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/INSTALL.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/QUICKSTART.html">Quickstart simulation using pre-trained models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../core/LICENSE.html">License</a></li>
Expand Down
Loading

0 comments on commit 786b862

Please sign in to comment.