Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
0a8298a
feat: remove truncate_values, which nothing calls
edkerk Nov 11, 2026
e282eb5
feat: predict DLKcat kcats with OpenKineticsPredictor by default
edkerk Nov 11, 2026
0786e45
doc: name the standard and the advanced kcat tuning
edkerk Nov 11, 2026
c132e41
fix: keep the OpenKineticsPredictor API key file out of git
edkerk Nov 11, 2026
c24b4d3
doc: correct function help, module notes and the relaxation methods page
edkerk Nov 11, 2026
6d839b8
fix: return no complexes from get_complex_data without a taxonomic id
edkerk Nov 11, 2026
41621b3
fix: check the target after the last allowed greedy relaxation
edkerk Nov 11, 2026
5de0823
fix: raise in fit_sigma for a target growth rate of 0
edkerk Nov 11, 2026
2833c53
fix: leave the isozyme kcats of collect_kcats unapplied
edkerk Nov 11, 2026
b2b507d
fix: report both complex proposals of a reaction in apply_complex_data
edkerk Nov 11, 2026
1703cc4
feat: include unreviewed entries in uniprot-download by default
edkerk Nov 11, 2026
562ba29
fix: skip the kegg download in load_kegg_tsv without an organism code
edkerk Nov 11, 2026
907264b
feat: download missing uniprot and kegg files in make_ec_model
edkerk Nov 11, 2026
f040c80
feat: take precomputed complex families in level_complex_concs
edkerk Nov 11, 2026
6868d28
feat: return the default f factor without proteomics data
edkerk Nov 11, 2026
81968bf
feat: take method in the sigma_fitter alias
edkerk Nov 11, 2026
eecb088
fix: merge a kcat_sources table into the preset settings
edkerk Nov 11, 2026
f27b3f6
fix: raise in ec_fseof when there is no production range to scan
edkerk Nov 11, 2026
fbe0ad2
feat: label ec_fseof targets and build its gene targets as ecFSEOF
edkerk Nov 11, 2026
e475e3e
style: remove the unused pytest import of a parity test
edkerk Nov 11, 2026
a1156c2
fix: raise in get_conc_control_coeffs on a model without optimal solu…
edkerk Nov 11, 2026
60970a5
fix: include unreviewed uniprot entries by default as the adapter does
edkerk Nov 11, 2026
ca90d5a
doc: name the current gecko paths and the matlab greedy relaxation
edkerk Nov 11, 2026
e2c4a01
feat: deprecate apply_custom_kcats and refuse the gecko 3 custom kcat…
edkerk Nov 11, 2026
0275828
feat: deprecate run_dlkcat and read_dlkcat_output
edkerk Nov 11, 2026
80f05e6
refactor: make the openkineticspredictor engine private
edkerk Nov 11, 2026
6f0eab4
doc: mark the low-level kcat functions in their docstrings
edkerk Nov 11, 2026
1c6663f
feat: use KinForm-H as the default okp method
edkerk Nov 11, 2026
b6d91b3
feat: use KinForm-H as the default OKP method of the presets
edkerk Nov 11, 2026
1644b67
feat: deprecate write_dlkcat_input in favour of kcats_from_dlkcat
edkerk Nov 11, 2026
9f539e7
fix: return converged false when greedy relaxation runs out
edkerk Nov 11, 2026
8142b55
fix: raise in fit_sigma for any growth rate not above 0
edkerk Nov 11, 2026
9862072
doc: state the okp methods of the preset comparison in collect_kcats
edkerk Nov 11, 2026
c9a6421
fix: refuse a GECKO 3 custom kcats file before changing the model
edkerk Nov 11, 2026
b4f4fce
feat: name replacements of removed functions in upgrade_project
edkerk Nov 11, 2026
725ac60
doc: predict dlkcat kcats with kcats_from_dlkcat in the full tutorial
edkerk Nov 11, 2026
de05622
feat: export EcFSEOFResult from geckopy
edkerk Nov 11, 2026
ec9bb27
fix: use the no-range tolerance of ecFSEOF in ec_fseof
edkerk Nov 11, 2026
746af93
test: keep the dlkcat okp test from submitting a real job
edkerk Nov 11, 2026
08fb08c
feat: leave the UniProt and KEGG identifiers empty by default
edkerk Nov 11, 2026
89d9b43
feat: remove the deprecated aliases with gecko 3 names
edkerk Nov 12, 2026
ef95b47
doc: drop the removed aliases from the docs and changelog
edkerk Nov 12, 2026
97839fe
Merge branch 'develop' into feat/gecko4-workflow
edkerk Nov 12, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ build/
htmlcov/
.claude/

# OpenKineticsPredictor API key of a project (see data/okpApiKey.txt in kcats_from_okp)
okpApiKey.txt

# Tutorial build outputs (the source yeast-GEM.yml is tracked).
tutorials/full_ecModel/models/ecYeastGEM*.yml
tutorials/full_ecModel/output/
Expand Down
25 changes: 25 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,31 @@

## Unreleased

* `uniprot.id` and `kegg.id` are empty by default instead of the identifiers of Saccharomyces cerevisiae (`"559292"` and `"sce"`), as in GECKO; `adapterParameters.tsv` is the same as GECKO's. `geckopy init` writes both uncommented as `""`, with examples in the comments. `make_ec_model` and `calculate_f_factor` raise `FileNotFoundError` naming `[uniprot] id` when `data/uniprot.tsv` is missing and the identifier is empty, as GECKO's `loadDatabases` raises `loadDatabases:noUniprotID`; an empty `kegg.id` leaves KEGG out with a warning. A project that relied on the yeast defaults sets the identifiers in model_adapter.toml.
* `upgrade_project` (`geckopy upgrade`) reports the calls of removed or replaced functions in the project's scripts with their replacement, for example `submit_open_kinetics_predictor`, `fetch_open_kinetics_predictor`, `build_okp_input_csv` and `truncate_values`.
* The deprecated aliases with GECKO 3 names are removed from `geckopy`: `run_dlkcat`, `read_dlkcat_output`, `write_dlkcat_input`, `apply_custom_kcats`, `get_kcat_across_isozymes`, `get_standard_kcat`, `select_kcat_value`, `merge_dlkcat_and_fuzzy_kcats`, `get_ec_from_database`, `get_ec_from_gem`, `sigma_fitter` and `constrain_flux_data`, and `find_max_value`, which ports `findMaxValue` that GECKO 4 removed. `upgrade_project` (`geckopy upgrade`) reports each of them in a project's scripts with its replacement, which `geckopy.upgrade.RENAMED` lists. `extract_enzyme_substrate_pairs` stays public.
* The `okp` source group of the presets is the OpenKineticsPredictor method KinForm-H alone by default, instead of the eight methods with combination parameters; a project that sets `[kcat_sources.okp] methods` keeps its list. `update_kcat_sources` then gathers `okp_kinform_h.tsv` only. GECKO uses the same default.
* The default of `okp.method` (the OpenKineticsPredictor method of `kcats_from_okp` without `method`) is `KinForm-H` instead of `CataPro`, as in GECKO.
* `submit_open_kinetics_predictor`, `fetch_open_kinetics_predictor`, `build_okp_input_csv` and `parse_okp_output` are private (`_submit_open_kinetics_predictor` and so on) and no longer exported from `geckopy`, `geckopy.gather_kcats` or `geckopy.gather_kcats.open_kinetics_predictor`: `kcats_from_okp` and `kcats_from_dlkcat(via="okp")` submit and fetch OpenKineticsPredictor jobs. GECKO moves its OKP engine functions into `kcatsFromOKP` in the same way. `OKPClient` and `OKPError` stay public.
* `convert_custom_kcats` (or `geckopy upgrade`) turns `data/customKcats.tsv` into `data/kcats/custom.tsv`. `collect_kcats` and `assign_kcats` do not apply `data/customKcats.tsv`: when a stage lists custom, `data/kcats/custom.tsv` does not exist and `data/customKcats.tsv` does, they raise `ValueError` naming `convert_custom_kcats`, before they change the model. The decisions have no stage `custom`. GECKO's `collectKcats` does the same.
* `download_uniprot` and `load_uniprot_tsv` download reviewed and unreviewed entries by default (`reviewed=False`), as the adapter default `uniprot.reviewed = false`; they downloaded reviewed entries only.
* `get_conc_control_coeffs` raises `ValueError` when the solve of the model as given is not optimal (for example infeasible), as GECKO's `getConcControlCoeffs` raises `getConcControlCoeffs:infeasible`; it returned no analysed proteins and zero coefficients.
* `ec_fseof` follows `ecFSEOF.m` in its labels, default and gene targets. `target_type` is `OE`, `KD` or `KO` instead of `amplify`, `knockdown` or `knockout`. `n_steps` defaults to 16 instead of 10. It returns an `EcFSEOFResult` (exported from `geckopy` and `geckopy.utilities`), raven-toolbox's `FSEOFResult` whose `gene_targets` has one row per gene with the columns `gene`, `name`, `slope` (the mean absolute slope of its target reactions), `action`, `essentiality` and `reactions`, ordered by slope: a gene with several actions is `OE` when one of them is `OE`, otherwise `KO` when it is not essential and `KD` when it is, essential meaning that growth is infeasible or below 1e-8 with the usage of its enzymes blocked and the production fixed at the last enforced level. `gene_targets` had the columns `gene`, `target_type` (the actions joined by `;`), `reactions` and `max_abs_slope`.
* `ec_fseof` raises `ValueError` when the top of the scan is not above the flux of the production target at maximum growth by more than `1e-9 * max(1, |top|)`, also for a target that cannot carry flux; GECKO's `ecFSEOF` raises `ecFSEOF:noRange` in the same case. The scan used to run on levels that do not rise and returned no targets.
* A `[kcat_sources.<name>]` table of model_adapter.toml overrides only the keys it sets of the preset's settings for that source, as in GECKO; it replaced them, so `[kcat_sources.brenda]` without `aggregation` under a median preset gathered BRENDA with the default aggregation (the maximum).
* `calculate_f_factor` takes no `prot_data` as well: it then reads `data/paxDB.tsv` of the adapter's project with `load_pax_db`, and without that file logs a warning and returns the default f of 0.5, as GECKO's `calculateFfactor` does. `prot_data` was required.
* `level_complex_concs` takes `families`, the complexes of the model as `complex_families` returns them (default: calculated from the model), as GECKO's `levelComplexConcs` does.
* `make_ec_model` without `uniprot_db` or `kegg_db` downloads a missing `data/uniprot.tsv` or `data/kegg.tsv` with the `[uniprot]` and `[kegg]` settings of the adapter, as GECKO's `makeEcModel` does through `loadDatabases`; an empty `kegg.id` leaves KEGG out with a warning. It used to raise `FileNotFoundError` for a missing `uniprot.tsv` and to use no KEGG data without `kegg.tsv`, so a project without `kegg.tsv` and with a `kegg.id` now gets the KEGG fallback for genes UniProt does not know.
* `load_kegg_tsv` with an empty `kegg_id` and no `kegg.tsv` logs a warning and returns None, as GECKO's `loadDatabases` does without a `kegg.ID`; it called `download_kegg` with an empty organism code, which raised.
* `geckopy uniprot-download` keeps reviewed and unreviewed entries by default, as the adapter default `uniprot.reviewed = false` and GECKO's `loadDatabases` do; `--reviewed-only` keeps the reviewed (Swiss-Prot) entries only. The option `--include-unreviewed` is removed; the command kept only reviewed entries by default.
* `apply_complex_data` reports up to two proposed complexes for a reaction, the closest superset and the best partial match, as GECKO's `applyComplexData` does; it reported the partial match only when there was no superset.
* `collect_kcats` returns the model with the decided kcats before `apply_kcat_constraints`, also for the kcats filled from isozymes, as GECKO's `collectKcats` does; it applied the constraints of the isozyme-filled reactions to the returned copy. `assign_kcats` gives the same model as before.
* `fit_sigma` raises `ValueError` for a target growth rate that is not above 0 (0, negative or NaN), before it changes the model, as GECKO's `sigmaFitter` raises `sigmaFitter:growthRate`; for 0 it fitted sigma to the smallest growth.
* `relax_proteomics_greedy` checks the growth after the last relaxation it is allowed: it returns a converged result when that relaxation reaches `minimal_growth`, and a result with `converged=False` and a warning when no candidate is left. It raises `RuntimeError` only when `max_iterations` relaxations leave growth below the target and candidates remain; it raised after `max_iterations` relaxations without checking the last one. GECKO's `relaxProteomicsGreedy` does the same.
* `get_complex_data` without a taxonomic ID (`taxonomic_id=None`) logs a warning and returns no complexes, without a query or a file written, as GECKO's `getComplexData` does; it raised `ValueError`.
* `geckopy init` writes a `.gitignore` with `data/okpApiKey.txt` in the new project, and the geckopy repository ignores `okpApiKey.txt`, so the OpenKineticsPredictor API key file stays out of git. The help said the file was git-ignored, which was not the case.
* `kcats_from_dlkcat` takes `via`: `"okp"` predicts with the DLKcat method of OpenKineticsPredictor (as `kcats_from_okp`), `"file"` reads `data/DLKcat.tsv` and `"docker"` runs DLKcat locally. The default is `"file"` when `data/DLKcat.tsv` exists and `"okp"` otherwise; `run=True` is the same as `via="docker"`. It returns `(kcat_list, done)` as `kcats_from_okp` does, with `kcat_list` `None` while an OKP job runs, and takes `wait`. `update_kcat_sources` gathers `dlkcat` through OKP when `data/DLKcat.tsv` is missing, needs an OKP API key for it and reports `pending` while the job runs, where it needed Docker. GECKO's `kcatsFromDLKcat` has the same option.
* `truncate_values` is removed from `geckopy.kcat_tuning` and `geckopy`; nothing in geckopy called it, and GECKO has removed `truncateValues`. `update_prot_pool` was never ported: `set_prot_pool_size` sets the protein pool for a condition.
* `geckopy.__version__` is the installed version of geckopy.
* `cma` is a required dependency of geckopy and the extra `evotune` is removed. `import geckopy` imports `cma`.
* `enzyme_usage` reports `measured_protein`, `demanded_protein` and `demand_ratio`, the usage of the enzymes with a measured concentration divided by their measured concentrations, and the same restricted to enzymes with a usage above 1e-7 mg/gDCW (`measured_protein_active`, `demand_ratio_active`). `report_enzyme_usage` reports `demand_ratio` and `demand_ratio_active`. GECKO's `getEnzymeUsage` and `reportEnzymeUsage` give the same values.
Expand Down
2 changes: 1 addition & 1 deletion docs/gecko_light_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Tests covering the light path:
| `Enzyme.concentration` setter (`Kcats.__setitem__`) | requires the per-enzyme usage upper-bound machinery |
| `constrain_enz_concs`, `flexibilize_enz_concs` | proteomics integration is per-enzyme; the shared pool can't represent it |
| `pfba_enzymes` | minimises per-enzyme usage reactions, which light doesn't have |
| `fill_kcats_from_isozymes` / `get_kcat_across_isozymes` | full-model isozyme aggregation; the light layout already represents isozymes as separate ec rows |
| `fill_kcats_from_isozymes` | full-model isozyme aggregation; the light layout already represents isozymes as separate ec rows |

All of these raise `NotImplementedError` with a clear message rather
than silently returning meaningless values.
Expand Down
Loading
Loading