Commit Graph

46 Commits

Author SHA1 Message Date
Alyssa Travitz
59bedc0535 drop scipy intersphinx link (#1621)
* drop scipy as intersphinx link

* clean up comments
2025-10-24 12:08:27 -07:00
Alyssa Travitz
dcc457d825 update example notebooks branch for v1.7.0 docs changes (#1615)
* bump example notebooks branch

* add ipykernel to env

* roll back to fixing septop branch

* i dont think we want ipykernel

* bump to tmp_fix_docs branch

* point to branch revert-237-v1.7_cookbooks

* point to latest example notebooks release
2025-10-24 07:20:00 -07:00
Alyssa Travitz
e81f2bcda1 add dark mode to docs (#1565)
* fix nb link

* bump examplenotebooks version

* add dark mode option back in

* temporary pin to working ofe theme branch

* remove unused code

* bump ci

* bump ofe-sphinx-theme pin
2025-10-14 20:10:13 -07:00
Alyssa Travitz
b9f7593b2d migrate to pydantic v2 (#1535) 2025-10-10 23:02:57 +00:00
Alyssa Travitz
0d4fabb0e3 add comment to explain gufe pin in env yamls (#1553) 2025-10-07 08:56:35 -04:00
Alyssa Travitz
4e603a1609 update docs theme (#1545)
* adding new branding assets

* remove images

* update theme branch

* CantinaPurple accent

* lowercase convention

* updating text

* remove dark mode for now

* fix sidebars

* fix formatting

* capitalization

* don't break spaces

* bump ci

* favicon!

* whitespace :(

* pin to sphinx release
2025-10-02 10:13:25 -04:00
Alyssa Travitz
9987706327 temporary pin to pre-pydantic v2 gufe commit (#1533)
* temporary pin to pre-pydantic v2 gufe commit

* pin docs too
2025-09-24 16:02:06 +00:00
Alyssa Travitz
1cb3ac79f1 debug rtd build memory error (#1510)
* try mambaforge build

* Revert "try mambaforge build"

This reverts commit 683e07f1ea.

* try explicit build

* try removing ambertools

* use the right env

* just add gufe pip install back

* add back openfe eco packages

* mock py3dmol

* add note for pip installs

* fix quote

* temporarily resort to SettingsBaseModel to get build

* specific imports

* dont use base settings placeholder
2025-09-15 13:32:22 -07:00
Alyssa Travitz
18314126a1 add pipe example for jq (#1505)
* add pipe example for jq

* pin to docutil 0.20

* try to avoid memory error
2025-09-12 13:12:56 -07:00
Alyssa Travitz
36849b8a09 debug docs build (#1489)
* don't build openmm

* mambaforge->miniconda for rtd

* artifically small build for debugging

* dont build env

* just build python

* add channels

* add sphinx packages to env

* add all non-openfe-ecosystem deps

* remove shim channel

* add openfe package

* add everything except openmm and toolkit

* add openmm

* add openff-toolkit

* only openff-toolkit

* try openff-toolkit-base

* try latest openff

* everybody back in

* build without openmm

* build with openff-toolkit-base

* bump rtd

* add pip build

* remove any openff-toolkit

* build w/o openmm

* add pip install

* build everything without pip install

* try no deps

* try custom build

* only python and pip

* try openfe-toolkit-base

* add temp deps for build with openff-toolkit-base

* add temp deps for build with openff-toolkit-base

* mock imports

* dont mock with toolkit base

* bump toolkit version

* Revert "bump toolkit version"

This reverts commit 6e3108a836.

* add mocks

* try pinnint to toolkit-base 0.13.0, no mocks

* back to >= 0.13.0 toolkit to make sure it wasn't a fluke

* mock imports
2025-08-26 07:34:40 -07:00
Alyssa Travitz
fcf7c86a57 bump python version in docs 2025-07-15 12:38:58 -07:00
Alyssa Travitz
67472c7cf8 updating environment yaml (#1385)
* updating pins

* remove min 8.2 pin

* pin example notebooks version

* update branch

* a comma

* min of 8.1.1

* add comment about pydantic min

* adding comment for openff-units pin

* updating openmm pin
2025-06-26 00:08:38 +00:00
Benjamin Ries
a3a7d5f207 Konnektor integration (#927)
* draft for Konnektor integration

* changing back to mappers iterable as parameter

* consistently using Konnektor also in loading fep or orion net

* adding handles for Konnektor functionality.

* used black for formatting.

* Update test_network_planning.py

fix for tests

* fixes for unittests:
- fix removing the central ligand from list.

* Update test_network_planning.py

remove test for testing if a central component is part of the other component list. This can not happen anymore with the current Konnektor implementation, therefore I propose removing the test.

* updating docstrings

* adjusting n_processes docstring language

* fixing central_ligand default

* rename mappers to mapper to avoid api break

* Revert "rename mappers to mapper to avoid api break"

This reverts commit bf82085d7a86be63d2eaca11e105261107229ecc.

* fixing mapper/s to avoid api break

* switching arg names from 'ligands' to new 'components' keyword to match konnektor

* reverting ordering change

* fixing docstring

* pull konnektor from main for development only

* mapper back to mappers to avoid api break

* clean up

* formatting

* mapper->mappers

* fixing call to network_from_indices

* update radial network test scorer to return between 0 and 1

* organizing tests into classes

* expect only one mapping per edge for maximal networks

* adding TODOs

* adding TODOs for later

* update index error string to match konnektor's clarity improvement

* updating pytest.raises to look for RuntimeError instead of ValueError

* adding TODO

* making unreachable test clearer

* fixing regex AGAIN

* some light formatting

* cleaning up diff

* central_ligand -> central component for msg regex

* regex

* updating regexes to match new konnektor behavior

* formatting :(

* formatting :(

* add connectedness check

* updating TODO

* fix comment

* update progress bar docstring

* fix ambiguous var name

* remove unused imports

* fix mypy checks

* remove unused testing code

* pin konnektor to 0.2

* remove completed TODOs

* add konnektor to docs env

* remove completed TODO

* updating news

* clarifying process and progress additions in news

---------

Co-authored-by: Alyssa Travitz <atravitz@umich.edu>
Co-authored-by: Alyssa Travitz <alyssa.travitz@omsf.io>
Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>
Co-authored-by: Irfan Alibay <IAlibay@users.noreply.github.com>
2025-06-17 13:53:16 -07:00
Alyssa Travitz
36f5fb8387 pin to ofe-sphinx-theme v0.2.0 2025-04-23 19:56:57 -07:00
Alyssa Travitz
939a7bdd29 moving under the hood to the user guide (#1221)
* moving under the hood to the user guide

* adding pip to docs env dependencies
2025-04-03 12:19:12 -07:00
Mike Henry
a831ffadbe Fix/pin sphinx le73 (#1147)
* pulls in <7.3 on RTD -- let's just match that

* sort deps and add a space for pins
2025-02-19 10:31:52 -08:00
Alyssa Travitz
c32f072ae2 update docs build (#1142)
* updating git ignore and renaming to environment.yml for consistency

* bump to sphinx<7.3

* back to yaml

* test newset sphinx + install from cf

---------

Co-authored-by: Mike Henry <11765982+mikemhenry@users.noreply.github.com>
2025-02-19 10:55:17 -07:00
Josh Horton
c46e7c1e5a add charges to cofactor sdf, fix docs, expose overwrite charges to plan CLI 2025-01-24 11:39:39 +00:00
Alyssa Travitz
3f350bb89c pinning to v0.1.0 sphinx theme release 2024-10-31 09:28:20 -07:00
Alyssa Travitz
af101dc6fe use latest ofe sphinx theme 2024-10-31 08:54:42 -07:00
Mike Henry
dee2b70248 build ofe theme without versioningit intergration (#914)
* build ofe theme without versioningit intergration

* fix commit hash
2024-08-02 14:08:01 -07:00
Benjamin Ries
7d40a633e4 Kartograf integration (#249)
* preparing openFE for wally integration

* name n refactor

* improving import managment.

* fixing network changes..

* reverting network extraction

* reverting network extraction

* refactor

* adding license

* refactor name

* removing the layer too much.

* Update environment.yml

* Update kartograf_mapper.py

* Update openfe/setup/__init__.py

Co-authored-by: Mike Henry <11765982+mikemhenry@users.noreply.github.com>

* Update environment.yaml

* Update environment.yml

* Update environment.yaml

* pin kartograf to v1.0.0 and above

* fixup merge mistake in generate_radial_network

* Update environment.yaml

* add kartograf integration to yaml cli

---------

Co-authored-by: Mike Henry <11765982+mikemhenry@users.noreply.github.com>
Co-authored-by: Richard Gowers <richardjgowers@gmail.com>
2023-11-17 18:04:33 +01:00
Richard Gowers
e60580c861 use Lomap package's bindings (#478)
* use Lomap package's bindings

* fix mypy complaints

* Code via suggestions because local branch is borked

Why can't I push this from my local?

* Update openfe/setup/atom_mapping/lomap_scorers.py

* try exporting __all__ (make RTD happy too)

* guess mypy didn't like that at __all__

* Oh, *that* would be how to fix the warning about mocks

* Update environment.yaml

* Update environment.yml

* Update conf.py

* remove lomap docs

* try adding lomap to docs build

* try adding lomap scorer docs back

* add generate_lomap_network to docs

* Update environment.yml

---------

Co-authored-by: David W.H. Swenson <david.swenson@omsf.io>
2023-11-03 11:20:37 +00:00
David W.H. Swenson
47cb562cc5 Merge branch 'main' of github.com:OpenFreeEnergy/openfe into sideload_examples 2023-10-10 16:36:23 -05:00
Josh Mitchell
5ee4f62f1d Use OpenFreeEnergy namespace 2023-09-28 13:28:41 +10:00
Josh Mitchell
40890983d8 Switch to OFE theme and remove redundant CSS 2023-09-20 18:29:33 +10:00
Josh Mitchell
4a864f603e Unpin nbsphinx-link 2023-09-04 12:02:06 +10:00
Josh Mitchell
06e120a63c Fix top-of-notebook links on RTD 2023-09-04 11:46:32 +10:00
Josh Mitchell
370c4f6c42 Get existing tutorials rendering in Sphinx 2023-08-29 19:15:23 +10:00
Josh Mitchell
2072c6b6ff Clone or update copy of ExampleNotebooks when building docs 2023-08-29 14:46:10 +10:00
Josh Mitchell
d3f3541782 Synchronise RTD and docs environments 2023-08-21 21:17:30 +10:00
Josh Mitchell
0a2fb8b398 Add sphinx pin to pip 2023-08-17 19:28:14 +10:00
Josh Mitchell
fe234f794c Pin Sphinx <7 2023-08-17 19:08:48 +10:00
Josh Mitchell
f43b13b069 Pin Sphinx 7.1 2023-08-17 18:58:41 +10:00
Irfan Alibay
29bb69dea3 pin pydantic and autodoc_pydantic (#517)
* pin pydantic and autodoc_pydantic

* two yaml files uh?
2023-08-07 16:01:04 +00:00
Josh A. Mitchell
17e7502e1e Merge branch 'main' into docs-updates 2023-07-25 00:27:38 -04:00
Mike Henry
5d7659168a now we tell users to install the latest version of openfe 2023-07-19 13:37:26 -07:00
Josh Mitchell
eb2c67a0e2 Check in SASS rather than compiled CSS 2023-07-19 11:44:43 +10:00
IAlibay
74fa4b98b8 try adding openff-tk to docs building 2023-06-01 09:15:27 +01:00
David W.H. Swenson
798ebcf87c add tqdm to docs env 2023-05-11 13:59:57 -04:00
Irfan Alibay
7cfb0fa983 Improving our landing page (#396)
* Improved landing page
2023-05-06 13:54:21 +01:00
richard gowers
6ebcb0a78b add sphinx-toolbox back to docs env 2023-04-26 21:40:39 +01:00
richard gowers
a6effdaa87 docs: add myst-parser to docs env 2023-04-26 21:40:39 +01:00
Irfan Alibay
bfb553adbe Update environment.yaml 2023-04-18 15:56:59 +01:00
Mike Henry
72e40388f3 collapse installer output 2023-04-17 15:58:08 -07:00
Mike Henry
a306ea5e54 Speed up doc building (#326)
* mock everything we can and make the env as small as we can

* It 👏 is 👏 .yaml 👏 not 👏 .yml

* use a cache

* bump ci

* auto dist

* make warnings errors when building locally
2023-04-07 16:39:02 -07:00