fsl-pipe-gui 0.0.0

terminal-based GUI for fsl-pipe

terminal-based GUI for fsl-pipe

Installation

pip install git+https://git.fmrib.ox.ac.uk/ndcn0236/fsl-pipe-gui.git

Any bug reports and feature requests are very welcome (see issue tracker).

Setting up local test environment

First clone the repository:

pip install https://git.fmrib.ox.ac.uk/ndcn0236/fsl-pipe-gui.git

Then, we install the package in an interactive manner:

cd fsl-pipe-gui
pip install -e .

Development tools can be installed using:

pip install -r requirements_dev.txt
pre-commit install  # installs pre-commit hooks to keep the code clean

Running tests

Tests are run using the pytest framework. They can be run from the project root as:

pytest src/tests

Compiling documentation

The documentation is build using sphinx. After installation (pip install sphinx) run:

cd doc
sphinx-build source build
open build/index.html

Contributing

Merge requests with any bug fixes or documentation updates are always welcome.

For new features, please raise an issue to allow for discussion before you spend the time implementing them.

Releasing new versions

• Run bump2version (install using pip install bump2version)
• Push to gitlab
• Manually activate the "to_pypi" task in the pipeline to upload to pypi