Skip to content

Commit

Permalink
Fix colab link and improve wording (#288)
Browse files Browse the repository at this point in the history
  • Loading branch information
pabloferz authored Oct 23, 2023
1 parent eca940c commit aeb07ad
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 11 deletions.
20 changes: 20 additions & 0 deletions docs/source/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Getting Started

PySAGES is designed to seamlessly integrate with your existing simulations.
For an easy start, we prepared examples in Google Colab notebooks, which provide
access to a working simulation environment and GPU hardware.
For example, you can use PySAGES with HOOMD-blue to run a simple [umbrella sampling
simulation][HOOMD Notebook].
Or, you can use PySAGES with OpenMM to explore the free energy landscape of the
conformational space of alanine dipeptide via [harmonic biasing][OpenMM Notebook].
Using the notebooks enables you to get started with PySAGES without any installation.
However, for a more productive deployment, we recommend a local installation instead.

We offer more examples, in the form of both Google Colab notebooks and scripts, for locally
installed PySAGES in the [examples path][Examples URL] within the GitHub repository.

<!-- References -->

[HOOMD Notebook]: https://colab.research.google.com/github/SSAGESLabs/PySAGES/blob/main/examples/hoomd-blue/umbrella_integration/Umbrella_Integration.ipynb
[OpenMM Notebook]: https://colab.research.google.com/github/SSAGESLabs/PySAGES/blob/main/examples/openmm/Harmonic_Bias.ipynb
[Examples URL]: https://github.com/SSAGESLabs/PySAGES/tree/main/examples
11 changes: 0 additions & 11 deletions docs/source/getting-started.rst

This file was deleted.

0 comments on commit aeb07ad

Please sign in to comment.