OpenFreeEnergy / OpenFreeEnergy/openfe

cli gather: add alchemical_network.json awareness

Open
#1,211 0 comments 0 reactions 1 assignee View on GitHub

@atravitz is already working on this.

Since Mar 28, 2025.

cli usability
Dominant language
Python
Stars
331
Forks
56
Avg merge
3d 9h
Merged PRs (30d)
13

Description

As discussed in openfe dev meeting, we should add the alchemical network as a cli gather argument, so that we can use it as the source of truth when checking for failed or missing runs.

The industry benchmarking scripts already do this, and we can achieve this without an api break by:

  • make alchemical_network cli arg optional
  • if alchemical_network arg is not passed, raise a warning that strongly encourages the user to pass in alchemical_network

in 2.0, we can discuss removing the legacy behavior.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.