Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# stratocaster
<img src="docs/assets/logo/stratocaster_logo_full.png" alt="stratocaster" width="300"/>

---

[![CI](https://github.com/OpenFreeEnergy/stratocaster/actions/workflows/tests.yaml/badge.svg)](https://github.com/OpenFreeEnergy/stratocaster/actions/workflows/tests.yaml)

Expand All @@ -13,4 +15,8 @@ Find the documentation for stratocaster on [Read the Docs](https://stratocaster.

## License

This project is released under the [MIT license](./LICENSE).
This project is released under the [MIT license](./LICENSE).

---

stratocaster logo by Jenke Scheen, copyright Datryllic LLC, is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0).
3 changes: 1 addition & 2 deletions devtools/conda-envs/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ channels:

dependencies:
- python>=3.12
- pip:
- git+https://github.com/OpenFreeEnergy/ofe-sphinx-theme
- furo
Binary file added docs/assets/logo/stratocaster_logo_full.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = 'ofe_sphinx_theme'
html_theme = 'furo'
html_static_path = ['_static']
9 changes: 7 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
stratocaster
============
.. image:: assets/logo/stratocaster_logo_full.png
:height: 300px
:alt: stratocaster logo

#######################################################################
AlchemicalNetwork Transformation Prioritization Library
#######################################################################

The stratocaster library is complimentary to gufe and provides suggestions, via Strategies, for optimally executing Transformation Protocols defined in AlchemicalNetworks.

Expand Down