Skip to content

Commit ad8666b

Browse files
committed
docs(readme): add a checklist of not-yet-implemented functionality
Convert the trailing 'what's still open' sentence in the Status section into a tick-box list (visualization, metabolomics-based (f)tINIT scoring, binary and KEGG artefact release publishing), and note that the MetaCyc / dynamic-FBA omissions are out of scope rather than pending.
1 parent eee7b8e commit ad8666b

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,22 @@ omissions:
4848
it ([`dfba`](https://pypi.org/project/dfba/), [`reframed`](https://pypi.org/project/reframed/),
4949
[`mewpy`](https://pypi.org/project/mewpy/)).
5050

51-
What's still open is catalogued in **[docs/todo.md](docs/reference/todo.md)** (visualisation / Phase
52-
6 is the main item).
51+
### Not yet implemented
52+
53+
Planned or partial functionality still on the books (full detail in
54+
**[docs/todo.md](docs/reference/todo.md)**):
55+
56+
- [ ] **Visualization (`plotting/`)** — pathway maps (Escher), omics-overlay and
57+
flux-distribution plots. *The main open item.*
58+
- [ ] **Metabolomics-based scoring in tINIT / ftINIT** — passing a non-empty `metabolomics`
59+
argument currently raises `NotImplementedError`.
60+
- [ ] **Published binary release ZIPs** (BLAST / DIAMOND / HMMER) — the resolver in
61+
`binaries.py` is ready; the registry is empty until the ZIPs are published as release assets.
62+
- [ ] **Published KEGG data-artefact releases** — the build pipeline exists; the artefact
63+
bundle is not published yet.
64+
65+
The two principled omissions above (MetaCyc reconstruction, dynamic FBA) are **not** on this
66+
list — they are deliberately out of scope, not pending work.
5367

5468
## Installation (development)
5569

0 commit comments

Comments
 (0)