Skip to content

Jazzed up the landing page for the docs; added links to related resources #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ianmkenney merged 3 commits into from
Mar 31, 2026
Merged

Jazzed up the landing page for the docs; added links to related resources #21

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1b97db2
Jazzed up the landing page for the docs, linked to related resources
dotsdl Mar 31, 2026
2816963
Typo fix
dotsdl Mar 31, 2026
af9af57
Revisions for consistent tone
dotsdl Mar 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,19 @@
:alt: stratocaster logo

#######################################################################
AlchemicalNetwork Transformation Prioritization Library
alchemical effort allocation, automated
#######################################################################

The stratocaster library is complimentary to gufe and provides suggestions, via Strategies, for optimally executing Transformation Protocols defined in AlchemicalNetworks.
**stratocaster** is a ``Strategy`` library for the `Open Free Energy`_ ecosystem: given an ``AlchemicalNetwork`` and any existing results for its ``Transformation``\s, a ``Strategy`` proposes where to apply additional computational effort to produce result data in an "optimal" way.
Different ``Strategy`` implementations define "optimal" differently, with the choice of ``Strategy`` determined by the application.

This library includes a set of Strategy implementations as well as base classes to facilitate the creation of custom Strategy implementations.
**stratocaster** includes many such ``Strategy`` implementations, as well as base classes and guidance for creating new ones.
A ``Strategy`` can be used directly on its own, or in combination with an automated execution system such as `alchemiscale`_ or `exorcist`_.
**stratocaster** is fully open source under the **MIT license**.

.. _Open Free Energy: https://openfree.energy/
.. _alchemiscale: https://alchemiscale.org/
.. _exorcist: https://github.com/OpenFreeEnergy/exorcist

.. toctree::
:maxdepth: 2
Expand Down