OpenFreeEnergy / OpenFreeEnergy/openfe

Choose better name to define states in AFE results

Open
#1,791 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Follow up from #1775

We currently set the two states for the AFE results as bound and unbound, this makes sense for ABFEs, but not so much for AHFEs.

We should choose a better name for this.

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.

Research direction

Start by reading issue #1775 and locating where AFE results define the bound and unbound states. Compare how those names apply to ABFEs and AHFEs, then propose terminology that accurately covers both result types. Done means the state names have been agreed on and the relevant definitions and uses are updated consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.