Commit Graph

584 Commits

Author SHA1 Message Date
Alyssa Travitz
25933de40b fix docs links for cli and api on landing page (#1620)
* fix links for cli and api

* fix cli link

* clearer language
2025-10-24 12:14:56 -07:00
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
d7d6f9dbb4 remove colab button, point to updated example notebooks, reorg landing page (#1618)
* remove colab button from example notebooks in docs

* point to example notebooks 2025.10.2

* replace 'try' with CLI
2025-10-24 19:06:25 +01: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
3a08b6809f Ci/add ruff format to openfe protocols (#1604)
* add more checks

* make precommit manual

* apply formatting to pyproject.toml

* add TODO

* remove unneeded, add a few more

* add ruff, but turn everything off

* add openfe known first party

* format highest-level files

* first half of openfe protocols

* second half of openfe protocols

* openfe protocols formatting, with alyssa's fmt skips

* add ruff formatter to precommit

* fmt: off all vendored _rfe_utils code

* addressing review comments
2025-10-22 16:04:13 -07:00
Alyssa Travitz
6e2f068952 add notes about dropping 3.10 maintenance (#1605)
* add notes about dropping 3.10 maintenance

* add version

* formatting
2025-10-22 11:35:26 -07:00
Irfan Alibay
84e090bfbe Prepare for release v1.7 (#1601)
* Updated CHANGELOG for 1.7.0

---------

Co-authored-by: Alyssa Travitz <alyssa.travitz@omsf.io>
2025-10-21 17:52:37 +01:00
Irfan Alibay
66d14f61bc ABFE protocol (#1045)
Add an Absolute Binding Free Energy Protocol to openfe.

Key features & limitations:
* Automatic Boresch restraint assignment.
* Does not handle net charge corrections yet.

---------

Co-authored-by: Irfan Alibay <IAlibay@users.noreply.github.com>
Co-authored-by: hannahbaumann <hbaumann@uci.edu>
Co-authored-by: Hannah Baumann <43765638+hannahbaumann@users.noreply.github.com>
2025-10-21 11:45:37 +01:00
Alyssa Travitz
141960944b deprecate openfe utils 3dviz in favor of gufe method (#1592)
* deprecate openfe utils 3dviz in favor of gufe method

* add news item

* update news

* fix deprecation warning capture

* update guide

---------

Co-authored-by: Irfan Alibay <IAlibay@users.noreply.github.com>
2025-10-20 23:56:23 +00:00
Josh Horton
f681d5160b add a note on the equilibration method (#1581) 2025-10-15 13:16:06 +00: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
d87dd8ffc0 fix nb link (#1574)
* fix nb link

* bump examplenotebooks version
2025-10-13 18:56:26 +01:00
Alyssa Travitz
b9f7593b2d migrate to pydantic v2 (#1535) 2025-10-10 23:02:57 +00:00
Alyssa Travitz
2d3af6a058 Release prep v1.6.1 (#1544)
* update partial charge tests now that a production NAGL model is available (#1506)

* update tests now that a production NAGL model is available

* fix mock

* clean up mocking

* add nagl test news item

* debug slow python 3.13 tests (#1468)

* Turn off minimization when we do a dry run
---------

Co-authored-by: IAlibay <IAlibay@users.noreply.github.com>

* update quickrun execution docs and add MPS link (#1483)

* add jq cookbook (#1488)

* add jq code blocks

* use tutorial data

* news

* 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

* add pipe example for jq (#1505)

* add pipe example for jq

* pin to docutil 0.20

* try to avoid memory error

* 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

* temp pin numpy (#1542)

* Removing unnecessary limit on resids (#1539)

* Removing unnecessary limit on resids indices gathering

* Updated CHANGELOG for 1.6.1

* add summary

* 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

* pin to gufe 1.6.1

* move env info before test imports

* bump single file installer to 3.12.11 to match colab

---------

Co-authored-by: IAlibay <IAlibay@users.noreply.github.com>
Co-authored-by: Iván Pulido <2949729+ijpulidos@users.noreply.github.com>
2025-10-07 18:41:50 +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
Hannah Baumann
ac06d1ca83 SepTop: Addressing issues raised in review (#1532)
* SepTop docs improvements lambda schedule and restraint selection

* Remove set_openmm_threads_1 logic from test_septop_slow

* change femto acknowledgements

* update method docstring limitations

* Make sure we fail when we have virtual sites and reassign_velocities is False

* clean up usage of openmm imports

* clean up equil settings output indices so that it enforces all

* generate smc_off_B on the fly

* Update enforcement of all output indices

* Simulation overview unclear on if the same restraint is used between repeats

* Add test for output indices validation

---------

Co-authored-by: Irfan Alibay <IAlibay@users.noreply.github.com>
2025-09-29 10:39:51 +01: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
Hannah Baumann
7584efec66 SepTop Protocol (#1057)
Adds an OpenMM-based SepTop Protocol.

---------

Co-authored-by: IAlibay <IAlibay@users.noreply.github.com>
Co-authored-by: Mike Henry <11765982+mikemhenry@users.noreply.github.com>
Co-authored-by: Josh Horton <joshua.horton@openforcefield.org>
2025-09-23 09:52:11 +01: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
aa27131533 add jq cookbook (#1488)
* add jq code blocks

* use tutorial data

* news
2025-08-25 10:25:52 -07:00
Alyssa Travitz
9f0800ffbb update quickrun execution docs and add MPS link (#1483) 2025-08-21 08:52:37 -07:00
Alyssa Travitz
9babfaf55e add a blurb for the 1.6.0 changelog (#1448) 2025-07-23 14:57:46 -07:00
Alyssa Travitz
8c47691931 release prep 1.6.0 (#1447)
* Updated CHANGELOG for 1.6.0

* add pr link

* update template
2025-07-23 14:50:56 -07:00
Alyssa Travitz
648473bd7f Update docs/installation.rst
Co-authored-by: Mike Henry <11765982+mikemhenry@users.noreply.github.com>
2025-07-15 15:52:00 -07:00
Alyssa Travitz
23e9f99ac7 exception for openeye and python 3.13 2025-07-15 13:21:23 -07:00
Alyssa Travitz
fcf7c86a57 bump python version in docs 2025-07-15 12:38:58 -07:00
Alyssa Travitz
6088cf3d4b not yet supporting 8.3.0 2025-06-30 09:46:50 -07:00
Alyssa Travitz
9aeff4ce44 remove openmm exclusion from docs 2025-06-30 08:57:32 -07:00
Alyssa Travitz
26c64f4580 Release prep v1.5.0 (#1390)
* Updated CHANGELOG for 1.5.0

* adding links to changelog

* update description

* fix links
2025-06-26 11:51:25 -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
Irfan Alibay
abfb62c95f Update userguide's ligand network wording for how scores are used. (#1382)
* Update userguide's ligand network wording for how scores are used.

* Update creating_ligand_networks.rst
2025-06-25 16:19:52 +00:00
Alyssa Travitz
aaf6fddbd8 improve ligand network description (#1172)
* hide todo from output

* trying to make ligand network description clearer

* adding api links

* updating language for clarity

* typo
2025-06-23 13:52:32 -07: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
e369a20b19 comment out TODO that was getting rendered (#1375) 2025-06-13 13:49:43 -07:00
Mike Henry
278bfd95ee Update docker build docs (#1344)
* Added note about custom docker builds
2025-06-05 12:23:05 -07:00
Alyssa Travitz
395ed35837 update notebook names (#1279) 2025-05-20 13:04:46 -07:00
Alyssa Travitz
148af2694c Update cli docs (#1264) 2025-04-30 13:46:11 -07:00
Alyssa Travitz
2d2fef2a07 Fix docs version (#1262)
* only use major and minor version in docs

* add issue number in comment

* updating version parsing
2025-04-29 11:03:32 -07:00
Alyssa Travitz
9296aa7fb0 Release prep 1.4.0 (#1253)
* Updated CHANGELOG for 1.4.0

* changing a word

* fixing formatting

* adding links (thanks mike)

* adding links

* adding description

* updating changelog
2025-04-25 07:02:27 -07:00
Alyssa Travitz
36f5fb8387 pin to ofe-sphinx-theme v0.2.0 2025-04-23 19:56:57 -07:00
Alyssa Travitz
0e21b35b00 Clean up tutorial index (#1233)
* switch to concise bulleted list for clarity

* updating description
2025-04-23 15:52:46 -07:00
Alyssa Travitz
8cc3c4f291 cli gather should allow lists of filepaths (#1212)
* allowing multiple paths

* first pass at allowing filepaths and wildcards

* updating docstring

* adding missing /

* add tests and sorting

* add news

* updating docstring

* updating docs

* fixing whitespace diff

---------

Co-authored-by: Mike Henry <11765982+mikemhenry@users.noreply.github.com>
2025-04-07 07:13:08 -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
Alyssa Travitz
fde3b1697f add PR 1210 to changelog (#1218) 2025-03-27 15:46:16 -07:00
Alyssa Travitz
e0885fdcac Updated CHANGELOG for 1.3.1 (#1216)
* Updated CHANGELOG for 1.3.1

* Update docs/CHANGELOG.rst

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

* Apply suggestions from code review

edits from mikemhenry

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

* formatting

* adding PR #

---------

Co-authored-by: Mike Henry <11765982+mikemhenry@users.noreply.github.com>
2025-03-27 15:30:49 -07:00
Alyssa Travitz
66ac2bdc64 migrate json loading to new gufe syntax (#1177)
* updates to cli from_json

* replacing dump instances with to_json

* Remove unnecessary imports of JSON_HANDLER

* addressing review

---------

Co-authored-by: Mike Henry <11765982+mikemhenry@users.noreply.github.com>
Co-authored-by: David L. Dotson <dotsdl@gmail.com>
2025-03-25 23:32:26 +00:00
Alyssa Travitz
31bb2a777d make gufe lowercase in docs (#1190)
* make gufe lowercase in docs

* Update docs/reference/index.rst

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

* Update docs/reference/api/index.rst

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

---------

Co-authored-by: Mike Henry <11765982+mikemhenry@users.noreply.github.com>
2025-03-14 09:55:24 -07:00