Commit 5298b8b0 authored by Paul McCarthy's avatar Paul McCarthy 🚵
Browse files

DOC: Re-arrange things to hopefully be a bit clearer

parent df6036ac
......@@ -31,15 +31,15 @@ FSL is organised into a number of repositories hosted at
https://git.fmrib.ox.ac.uk.
- `fsl/conda/docs`: (this repository): High level documentation
- `fsl/conda/manifest`: Metadata for managing public and internal FSL
releases.
- `fsl/conda/manifest-rules`: CI configuration used by the
`fsl/conda/manifest` repository.
- `fsl/<project>`: Source code repository for FSL project `<project>`
- `fsl/conda/fsl-<project>`: Conda recipe repository for FSL project
`<project>`
- `fsl/fsl-ci-rules`: CI rules for automated building and publishing of
FSL conda packages
- `fsl/conda/manifest`: Generating and releasing `manifest.json` and
`environment.yml` files for public and internal FSL releases.
- `fsl/conda/manifest-rules`: Scripts used by the `fsl/conda/manifest`
repository.
- `fsl/conda/installer`: Home of the `fslinstaller.py` script, for
installing FSL
......@@ -69,20 +69,30 @@ follows:
## FSL releases
FSL releases are installed via a script called `fslinstaller.py`, which is
maintained at the fsl/conda/installer> repository.
Public and internal FSL release are defined by a set of conda
[`environment.yml`
files](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#create-env-file-manually),
one for each supported platform and CUDA version. Each `environment.yml` file
contains a list of the packages which are included in the FSL release.
FSL releases are described by a `manifest.json` file, which is an index of all
available `environment.yml` files, and which contains all of the information
needed to install a particular FSL release.
Each available build (e.g. Linux, macOS, etc) for official FSL release is
defined by a conda [`environment.yml`
specification](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#create-env-file-manually).
This specification contains a list of all of the packages, including their
versions, to be installed. Available `environment.yml` builds are described by
a `manifest.json` file. The `manifest.json` and `environment.yml` files for
both public and internal releases are generated from information stored in the
fsl/conda/manifest> repository.
The fsl/conda/manifest> repository is where new FSL releases, both public and
internal, are created. The `environment.yml` and `manifest.json` files for a
new release are automatically generated from information stored in the
`fsl-release.yml` file in that repository.
## The `fslinstaller.py` script
FSL releases are installed via a script called `fslinstaller.py`, which is
maintained at the fsl/conda/installer> repository.
The `fslinstaller.py` script performs the following tasks:
1. Downloads the FSL release `manifest.json` file, and the appropriate
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment