Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
"image_dark": "_static/raven-logo-white.png",
},
"announcement": (
"This site documents RAVEN <strong>3.0.0b1</strong> "
"This site documents RAVEN <strong>3.0.0b2</strong> "
"(MATLAB and Python), a pre-release version. The API may still "
"change before the stable 3.0.0 release."
),
Expand Down
2 changes: 1 addition & 1 deletion docs/data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The models that the pages of the [user guide](../guide/index.md) load are copied
| [`curation-mets.tsv`](curation-mets.tsv) | 0.3 kB | written for this guide | [Table-driven curation](../guide/curation.md): a metabolite curation table |
| [`hpa-sample.tsv`](hpa-sample.tsv) | 1 kB | an excerpt of ten rows in Human Protein Atlas format | [Context-specific models with ftINIT](../guide/init.md) |

The two small yeast models are part of the RAVEN Toolbox (MIT licence). yeast-GEM is the consensus genome-scale model of *Saccharomyces cerevisiae* ([SysBioChalmers/yeast-GEM](https://github.com/SysBioChalmers/yeast-GEM), CC-BY-4.0). It is pinned at release v9.1.0, so the numbers printed in the guide stay reproducible while the model develops.
The two small yeast models are part of the RAVEN Toolbox (GPL-3.0 licence). yeast-GEM is the consensus genome-scale model of *Saccharomyces cerevisiae* ([SysBioChalmers/yeast-GEM](https://github.com/SysBioChalmers/yeast-GEM), CC-BY-4.0). It is pinned at release v9.1.0, so the numbers printed in the guide stay reproducible while the model develops.

The `.yml` files are RAVEN YAML, read by `readYAMLmodel` in MATLAB and `read_yaml_model` in Python. `yeast-GEM.xml` is SBML, read by `importModel` and by `read_sbml_model` of cobrapy.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Add the folder to the MATLAB path and run `checkRaven`, which reports whether th
:::
:::{tab-item} MATLAB (Add-Ons)

The Add-Ons manager installs the latest stable release, RAVEN 2.x. RAVEN 3.0.0b1, which this site documents, is installed from git or from a source archive; see [RAVEN (MATLAB)](installation/raven.md).
The Add-Ons manager installs the latest stable release, RAVEN 2.x. RAVEN 3.0.0b2, which this site documents, is installed from git or from a source archive; see [RAVEN (MATLAB)](installation/raven.md).
:::
::::

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ raven-toolbox fetches KEGG data and the reconstruction binaries (BLAST+, DIAMOND

## Installation

The release documented on this site, 3.0.0b1, is a pre-release. PyPI also holds the stable release 0.4.0, and `pip` selects that release unless `--pre` is given.
The release documented on this site, 3.0.0b2, is a pre-release. PyPI also holds the stable release 0.4.0, and `pip` selects that release unless `--pre` is given.

::::{tab-set}
:::{tab-item} {octicon}`package;1em` From PyPI
Expand Down
18 changes: 9 additions & 9 deletions docs/installation/raven.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,16 +51,16 @@ setRavenSolver('cobra');

## Installation

:::{admonition} Installing 3.0.0b1
:::{admonition} Installing 3.0.0b2
:class: warning

This site documents RAVEN 3.0.0b1, a pre-release. The Add-Ons manager and the normal releases page of the release download offer the latest stable release (RAVEN 2.x), so neither installs 3.0.0b1. The Clone with git tab or the archive link of the Release download tab installs it.
This site documents RAVEN 3.0.0b2, a pre-release. The Add-Ons manager and the normal releases page of the release download offer the latest stable release (RAVEN 2.x), so neither installs 3.0.0b2. The Clone with git tab or the archive link of the Release download tab installs it.
:::

::::{tab-set}
:::{tab-item} {octicon}`plug;1em` Add-Ons manager

The installation runs from within MATLAB and needs no separate download. The installed version is the latest stable release (RAVEN 2.x), which is older than 3.0.0b1, as the warning at the start of the [Installation](#installation) section states.
The installation runs from within MATLAB and needs no separate download. The installed version is the latest stable release (RAVEN 2.x), which is older than 3.0.0b2, as the warning at the start of the [Installation](#installation) section states.

1. Open the Home tab and select Add-Ons, then Get Add-Ons.
2. Search for RAVEN Toolbox and select Add, then Add to MATLAB.
Expand All @@ -70,21 +70,21 @@ When MATLAB does not pick up the toolbox after step 2, `matlab.addons.enableAddo
:::
:::{tab-item} {octicon}`download;1em` Release download

This method suits offline and managed environments. The [RAVEN releases page](https://github.com/CompMetEng/RAVEN/releases) lists stable releases, and 3.0.0b1 is a git tag without a packaged release, so the archive is downloaded directly:
This method suits offline and managed environments. The [RAVEN releases page](https://github.com/CompMetEng/RAVEN/releases) lists stable releases, and 3.0.0b2 is a git tag without a packaged release, so the archive is downloaded directly:

1. Download [the 3.0.0b1 archive](https://github.com/CompMetEng/RAVEN/archive/refs/tags/3.0.0b1.zip), which works without git.
1. Download [the 3.0.0b2 archive](https://github.com/CompMetEng/RAVEN/archive/refs/tags/3.0.0b2.zip), which works without git.
2. Extract it to any location.
3. In MATLAB, add the RAVEN folder to the path (`pathtool`) and [verify](#verification).
:::
:::{tab-item} {octicon}`git-branch;1em` Clone with git

The commands clone the repository and check out the `3.0.0b1` tag. A plain `git clone` follows the `develop` branch, which can contain changes made after the pre-release documented on this site.
The commands clone the repository and check out the `3.0.0b2` tag. A plain `git clone` follows the `develop` branch, which can contain changes made after the pre-release documented on this site.

```bash
git clone --depth=1 https://github.com/CompMetEng/RAVEN.git
cd RAVEN
git fetch --depth=1 origin tag 3.0.0b1
git checkout 3.0.0b1
git fetch --depth=1 origin tag 3.0.0b2
git checkout 3.0.0b2
```

Afterwards, add the RAVEN folder to the MATLAB path and [verify](#verification).
Expand Down Expand Up @@ -156,7 +156,7 @@ MATLAB should be closed, the old RAVEN folder deleted, the new release downloade
:::
:::{tab-item} {octicon}`git-branch;1em` Clone with git

The `3.0.0b1` tag does not move, so a checkout of it has nothing to pull. The development branch is followed with:
The `3.0.0b2` tag does not move, so a checkout of it has nothing to pull. The development branch is followed with:

```bash
git checkout develop
Expand Down
Loading