-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix colab link and improve wording (#288)
- Loading branch information
Showing
2 changed files
with
20 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file was deleted.
Oops, something went wrong.