Commit cfca8cc2 authored by William Clarke's avatar William Clarke
Browse files

Update changelog with WIP notes and update readme for documentation.

parent 05e5b5fc
This document contains the FSL-MRS release history in reverse chronological order. This document contains the FSL-MRS release history in reverse chronological order.
WIP
---
- Internal changes to core MRS class.
- New plotting functions added, utility functions for plotting added to MRS class.
- fsl_mrs/aux folder renamed for Windows compatibility.
- Moved online documentation to open.win.ox.ac.uk/pages/fsl/fsl_mrs/.
- Fixed small bugs in preprocessing display.
1.0.5 (Friday 9th October 2020) 1.0.5 (Friday 9th October 2020)
------------------------------- -------------------------------
- Extended documentation of hardcoded constants, including MCMC priors. - Extended documentation of hardcoded constants, including MCMC priors.
......
...@@ -9,7 +9,7 @@ FSL-MRS is a collection of python modules and wrapper scripts for pre-processing ...@@ -9,7 +9,7 @@ FSL-MRS is a collection of python modules and wrapper scripts for pre-processing
### Installation ### Installation
#### Conda package #### Conda package
The primary installation method is via _conda_. After installing conda and creating or activating a suitable [enviroment](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html) you can install FSL-MRS from the FSL conda channel. The primary installation method is via _conda_. After installing conda and creating or activating a suitable [environment](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html) you can install FSL-MRS from the FSL conda channel.
conda install -c conda-forge \ conda install -c conda-forge \
-c https://fsl.fmrib.ox.ac.uk/fsldownloads/fslconda/channel/ \ -c https://fsl.fmrib.ox.ac.uk/fsldownloads/fslconda/channel/ \
...@@ -59,7 +59,7 @@ After installation see the [quick start guide](https://users.fmrib.ox.ac.uk/~saa ...@@ -59,7 +59,7 @@ After installation see the [quick start guide](https://users.fmrib.ox.ac.uk/~saa
### Documentation ### Documentation
Documentation can be found online [here](https://users.fmrib.ox.ac.uk/~saad/fsl_mrs/html/index.html). Documentation can be found online on the [WIN open science website](https://open.win.ox.ac.uk/pages/fsl/fsl_mrs/).
For each of the wrapper scripts above, simply type `<name_of_script> --help` to get the usage. For each of the wrapper scripts above, simply type `<name_of_script> --help` to get the usage.
......
Supports Markdown
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