Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
d374236
Cite localization/predictLocalization.m in the predict_localization t…
edkerk Oct 31, 2026
24a7014
Give boxes their title as an admonition title
edkerk Oct 31, 2026
68a74d9
Rewrite the parameter-tuning pages from the scripts and the code
edkerk Oct 31, 2026
019e434
Correct the parameter-tuning pages after review
edkerk Oct 31, 2026
034f3dc
Correct the parameter-tuning studies against reruns and name their sc…
edkerk Nov 1, 2026
ae7560d
Add the parameter-tuning study scripts and point the study pages to them
edkerk Nov 1, 2026
9565418
Merge remote-tracking branch 'origin/main' into ci-fix
edkerk Nov 1, 2026
f966811
Update the documented sampling means to the pinned raven-toolbox
edkerk Nov 1, 2026
acf2e3f
Rewrite the migration and comparison pages against the RAVEN 2.11.3, …
edkerk Nov 1, 2026
a7645dc
Name the removed MetaCyc, pathway, plotting and legacy code as folders
edkerk Nov 1, 2026
fb8faba
Write the migration and comparison pages anew from their verified claims
edkerk Nov 1, 2026
20f9065
Merge main into docs/migration-claims
edkerk Nov 1, 2026
597dbb1
Write the benchmarks page anew
edkerk Nov 1, 2026
eb93680
Write the Human-GEM validation page anew
edkerk Nov 1, 2026
1af8716
Write the homology calibration page anew
edkerk Nov 1, 2026
759ad60
Write the ftINIT calibration page anew
edkerk Nov 1, 2026
84d9097
Write the ftINIT reproducibility page anew
edkerk Nov 1, 2026
ba3a209
Write the KEGG calibration page anew
edkerk Nov 1, 2026
6854456
Write the sampling convergence page anew
edkerk Nov 1, 2026
f598bfb
Reword five sentences flagged by the style check
edkerk Nov 1, 2026
7bcc0a6
Apply the review of the rewritten migration, comparison and parameter…
edkerk Nov 1, 2026
64935ea
Name tINIT as the legacy method that ftINIT replaces
edkerk Nov 1, 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
2 changes: 1 addition & 1 deletion docs/guide/fba.md
Original file line number Diff line number Diff line change
Expand Up @@ -317,4 +317,4 @@ The growth rate is unchanged and the total flux is the smallest that achieves it
- [Getting started](getting-started.md), loading and inspecting a model.
- [Growth media and conditions](media.md), what the exchange bounds mean and how
to define a medium.
- [MATLAB vs Python](../raven3-vs-raven-toolbox.md), the full function mapping.
- [MATLAB vs Python](../matlab-vs-python.md), the full function mapping.
2 changes: 1 addition & 1 deletion docs/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,5 +272,5 @@ An empty dictionary means the reaction balances. Anything listed is an element,
## See also

- [Guide overview](index.md), the other pages, and the planned pages.
- [MATLAB vs Python](../raven3-vs-raven-toolbox.md), what each toolbox has, and where cobrapy takes over.
- [Comparison of RAVEN and raven-toolbox](../raven3-vs-raven-toolbox.md), what each toolbox has, and where cobrapy takes over.
- [API reference](../api/index.md), every function in both toolboxes.
10 changes: 5 additions & 5 deletions docs/guide/init.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Context-specific models with ftINIT

A genome-scale model describes what an organism can do. tINIT and ftINIT reduce it to what a particular sample (a tissue, a cell line, a condition) appears to be doing, from expression data plus a list of metabolic tasks that the result must be able to perform.
A genome-scale model describes what an organism can do. ftINIT reduces it to what a particular sample (a tissue, a cell line, a condition) appears to be doing, from expression data plus a list of metabolic tasks that the result must be able to perform. The legacy method tINIT, which ftINIT replaces, does the same for models that were built with it.

The workflow uses Human-GEM and the RNA-seq data that Human-GEM provides, in both toolboxes.

## Choice of method

ftINIT is the recommended method, and the workflow here uses it.
ftINIT is the recommended method and replaces the legacy method tINIT. The workflow uses ftINIT.

Use tINIT (`getINITModel`) only to reproduce a model that was built with it. tINIT is supported and is not scheduled for removal. It issues a `RAVEN:legacyMethod` notice, which states that it is not intended for new work. Silence the notice with `warning('off','RAVEN:legacyMethod')`.
Use tINIT (`getINITModel`) to reproduce a model that was built with it. tINIT is supported and is not scheduled for removal. It issues a `RAVEN:legacyMethod` notice, which states that it is not intended for new work. Silence the notice with `warning('off','RAVEN:legacyMethod')`.

tINIT is MATLAB-only. RAVEN includes it for the models already built with it; raven-toolbox, an implementation without such an installed base, includes ftINIT only. A tINIT model has to be reproduced in MATLAB.
The legacy method tINIT is MATLAB-only. RAVEN includes it for the models already built with it; raven-toolbox, an implementation without such an installed base, includes ftINIT only. A tINIT model has to be reproduced in MATLAB.

## Relation between tINIT and ftINIT

Expand Down Expand Up @@ -44,7 +44,7 @@ The same MATLAB workflow, as the model's own documentation presents it and inclu
| `ftINIT` | `ftinit` | the staged extraction |
| `scoreModel` | `score_reactions_from_genes` | gene scores → reaction scores |
| no equivalent | `gene_scores_from_expression` | expression → gene scores |
| `runINIT`, `getINITModel` | no equivalent | tINIT, for reproducing models built with it |
| `runINIT`, `getINITModel` | no equivalent | the legacy tINIT method, for reproducing models built with it |
| `removeLowScoreGenes` | `remove_low_score_genes` | prune negative-scoring genes from gene-protein-reaction rules (GPRs) |
| `parseHPA`, `parseHPArna` | `parse_hpa`, `parse_hpa_rna` | read Human Protein Atlas (HPA) dumps |
| no equivalent | `hpa_gene_scores`, `rna_gene_scores` | HPA levels or transcripts per million (TPM) to gene scores |
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/io.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,4 +266,4 @@ print(sorted(p.relative_to(root).as_posix() for p in root.rglob("*") if p.is_fil

- [Getting started](getting-started.md), what to do with the model once it is loaded.
- [Guide overview](index.md), the other pages and the planned pages.
- [MATLAB vs Python](../raven3-vs-raven-toolbox.md), the full function mapping, including everything that resolves to cobrapy.
- [MATLAB vs Python](../matlab-vs-python.md), the full function mapping, including everything that resolves to cobrapy.
2 changes: 1 addition & 1 deletion docs/guide/media.md
Original file line number Diff line number Diff line change
Expand Up @@ -358,4 +358,4 @@ The values are uptake rates and not bounds, and the zeros are components that th
- [Simulating growth with FBA](fba.md), the solve that uses the medium.
- [Reading and writing models](io.md), keeping a model and its conditions in a
repository.
- [MATLAB vs Python](../raven3-vs-raven-toolbox.md), the full function mapping.
- [MATLAB vs Python](../matlab-vs-python.md), the full function mapping.
2 changes: 1 addition & 1 deletion docs/guide/model-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -327,4 +327,4 @@ RAVEN and the COBRA Toolbox use different field names for the same model. In MAT

- [Getting started](getting-started.md), loading a model and inspecting it.
- [Reading and writing models](io.md), where identifier prefixes come from.
- [MATLAB vs Python](../raven3-vs-raven-toolbox.md), the full function mapping.
- [MATLAB vs Python](../matlab-vs-python.md), the full function mapping.
4 changes: 2 additions & 2 deletions docs/installation/data-and-binaries.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The path `~/.cache` is used literally on every platform, and the platform conven

The version is part of the path, so two KEGG releases coexist and a pinned run fetches the release it was pinned to when that release is missing from the cache.

In MATLAB the KEGG artefacts go to the directory `dataDir`, which `getKEGGModelForOrganism` requires as an argument. The executables are stored in `software/` inside the RAVEN installation directory on every platform.
In MATLAB the KEGG artefacts go to the directory `dataDir`, which `getKEGGModelForOrganism` requires as an argument. The executables are stored in `src/external/<tool>` (`blast+`, `diamond`, `hmmer`) inside the RAVEN installation directory on every platform.

## Tool resolution

Expand Down Expand Up @@ -77,7 +77,7 @@ Downloading on first use puts the download inside the first run, which is not al
downloadRavenBinaries
```

`downloadRavenBinaries` fetches the executables that RAVEN needs into its `software/` directory. The KEGG artefacts are fetched separately, on the first `getKEGGModelForOrganism` call, into the `dataDir` given there.
`downloadRavenBinaries` fetches the executables that RAVEN needs into the `src/external/` directory of the RAVEN installation. The KEGG artefacts are fetched separately, on the first `getKEGGModelForOrganism` call, into the `dataDir` given there.
:::
:::{tab-item} 🐍 Python
:sync: python
Expand Down
4 changes: 2 additions & 2 deletions docs/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ Both versions need a linear-programming solver. The options are the same for eit

| Solver | Licence | Suited to |
|---|---|---|
| Gurobi | Free academic | Genome-scale models, tINIT and ftINIT, gap-filling (recommended) |
| Gurobi | Free academic | Genome-scale models, ftINIT and the legacy tINIT method, gap-filling (recommended) |
| GLPK | Open source | Small to medium models, getting started |
| SCIP | Open source | MILP problems (MATLAB) |
| SCIP | Open source | MILP problems (MATLAB); `setRavenSolver('scip')` downloads the binary on Windows only |

In MATLAB, `setRavenSolver('gurobi')` selects the active solver. In raven-toolbox, the solver is configured through cobrapy (`cobra.Configuration`).

Expand Down
4 changes: 2 additions & 2 deletions docs/installation/raven.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The RAVEN Toolbox runs in MATLAB and works independently. It does not require th

## Requirements

- MATLAB R2016b or later. R2016b is the oldest release that the code guards for. Continuous integration tests R2024b only. No additional MathWorks toolboxes are required.
- MATLAB, with no minimum release stated. The code has no check that rejects an older release. `readYAMLmodel` has a fallback for releases before R2020b, `parseTaskList` calls `readcell` (R2019a) for Excel task lists and `addIdentifierPrefix` calls `regexpPattern` (R2020b). Continuous integration tests R2024b only; older releases were not tested. No additional MathWorks toolboxes are required.
- A linear-programming solver: [Gurobi](https://www.gurobi.com/) (free academic licence, recommended) or GLPK, bundled with RAVEN itself and needing no separate install. See [Choosing and configuring a solver](#choosing-a-solver-matlab).
- RAVEN bundles `libSBML` and the GLPK mex files for Windows, macOS and Linux. `BLAST+`, `DIAMOND` and `HMMER` are not bundled: RAVEN fetches the build for the platform on first use, so the reconstruction functions need internet access the first time they run. `downloadRavenBinaries` fetches them ahead of time. [Download data and binaries](data-and-binaries.md) lists the full set, where it is cached and how to prepare an offline machine.

Expand All @@ -16,7 +16,7 @@ The RAVEN Toolbox runs in MATLAB and works independently. It does not require th
| Solver | LP | MILP | Relative speed | Licence |
|---|---|---|---|---|
| GLPK | yes | yes (RAVEN warns; slow on large problems) | 1x (baseline) | open source, bundled with RAVEN |
| SCIP | yes | yes | 0.33x | open source; bundled on Windows, a separate install on macOS or Linux |
| SCIP | yes | yes | 0.33x | open source; `setRavenSolver('scip')` downloads the MEX file on Windows (from the RAVEN v2.8.6 GitHub release), a separate install on macOS or Linux |
| Gurobi | yes | yes | 4.2x | free academic licence |
| COBRA Toolbox | yes | depends on the COBRA solver configured | depends on the COBRA solver configured | depends on the COBRA solver configured |

Expand Down
11 changes: 5 additions & 6 deletions docs/migrate.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# Migrate
# Migration guides

Two ways of moving between versions or languages, each answering a
different question.
Two pages compare toolboxes. One compares RAVEN 3 with RAVEN 2, the other RAVEN 3 with the Python package raven-toolbox.

| | |
| Page | Use |
|---|---|
| [RAVEN 2 → RAVEN 3 (MATLAB)](raven3-migration.md) | Upgrading an existing MATLAB codebase: what was renamed, removed outright, or changed between RAVEN 2 and RAVEN 3. |
| [RAVEN 3 → raven-toolbox](raven3-vs-raven-toolbox.md) | Choosing between the two current implementations, or porting a MATLAB workflow to Python: what each toolbox has, and where they answer the same question differently. |
| [RAVEN 2 → RAVEN 3 (MATLAB)](raven3-migration.md) | Upgrading a MATLAB codebase: which functions were renamed or removed, and which behaviour differs between RAVEN 2 and RAVEN 3. |
| [RAVEN 3 → raven-toolbox](raven3-vs-raven-toolbox.md) | Choosing between the two current implementations or porting a MATLAB workflow to Python: what each toolbox has, and where they answer the same question differently. |

```{toctree}
:hidden:
Expand Down
Loading
Loading