Skip to content

Rewrite the home page, Guide, installation, tutorials and protocol pages - #112

Merged
edkerk merged 7 commits into
mainfrom
docs/rewrite-home-guide-installation
Nov 1, 2026
Merged

edkerk merged 7 commits into
mainfrom
docs/rewrite-home-guide-installation

Conversation

@edkerk

@edkerk edkerk commented Nov 1, 2026

Copy link
Copy Markdown
Collaborator

The home page, the 23 Guide pages, the installation pages, the five legacy tutorials, the ten protocol pages, yaml-format.md, data/README.md and tuned-parameters.md are written anew from their content. The code and output blocks are unchanged, except for the quick start of the home page and the PyPI installation commands.

Statements corrected against the code and the releases:

  • PyPI holds the stable release 0.4.0 and the pre-release 3.0.0b1, so the installation commands are pip install --pre raven-toolbox.
  • The MATLAB Add-Ons tab of the home page installs RAVEN 2.x, and MOSEK is no longer a solver of setRavenSolver.
  • Download sizes follow the assets of the toolbox-assets releases (49 MB KEGG core bundle, 135 MB and 155 MB HMM libraries), and bundles exist for Linux x86-64, macOS arm64 and Windows x86-64.
  • parseTaskList requires the ID column and a header row that starts with an empty cell; the full set of columns is optional.
  • getModelFromHomology keeps a reaction with a missing subunit under the default complexPolicy flag.
  • constrain_reversible_reactions has eps=1e-10, and ftinit has no eps parameter.
  • reservedRxns of simplifyModel protects against three of the flags.
  • prepINITModel runs serially by default.
  • yaml-format.md states that a round trip through cobrapy drops the RAVEN extensions.
  • The answer boxes of Tutorial 4 are dropdown blocks, which this site renders; the previous ??? syntax rendered as plain text.
  • The RAVEN source link in yaml-format.md points to src/io.

The pages are written anew from their content, with the code blocks unchanged. PyPI installation commands use --pre, because the stable release on PyPI is 0.4.0. Download sizes follow the toolbox-assets release assets. The answer boxes of Tutorial 4 use dropdowns.
@read-the-docs-community

read-the-docs-community Bot commented Nov 1, 2026 •

Copy link
Copy Markdown

Documentation build overview

📚 raven-docs | 🛠️ Build #35561632 | 📁 Comparing db111c4 against latest (0b61876)

  🔍 Preview build  

47 files changed · ± 47 modified

± Modified

@edkerk
edkerk merged commit c2a69f0 into main Nov 1, 2026
5 checks passed
@edkerk
edkerk deleted the docs/rewrite-home-guide-installation branch November 1, 2026 21:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant