Skip to content

Latest commit

 

History

History
110 lines (73 loc) · 3.12 KB

README.md

File metadata and controls

110 lines (73 loc) · 3.12 KB
Raw

Zero MRI Background

Version MIT License ci

pl-zerobg is a ChRIS ds plugin which takes in ... as input files and creates ... as output files.

Abstract

...

Installation

pl-zerobg is a ChRIS plugin, meaning it can run from either within ChRIS or the command-line.

Local Usage

To get started with local command-line usage, use Apptainer (a.k.a. Singularity) to run pl-zerobg as a container:

apptainer exec docker://fnndsc/pl-zerobg zb [--args values...] input/ output/

To print its available options, run:

apptainer exec docker://fnndsc/pl-zerobg zb --help

Examples

zb requires two positional arguments: a directory containing input data, and a directory where to create output data. First, create the input directory and move input data into it.

mkdir incoming/ outgoing/
mv some.dat other.dat incoming/
apptainer exec docker://fnndsc/pl-zerobg:latest zb [--args] incoming/ outgoing/

Development

Instructions for developers.

Building

Build a local container image:

docker build -t localhost/fnndsc/pl-zerobg .

Running

Mount the source code zb.py into a container to try out changes without rebuild.

docker run --rm -it --userns=host -u $(id -u):$(id -g) \
    -v $PWD/zb.py:/usr/local/lib/python3.11/site-packages/zb.py:ro \
    -v $PWD/in:/incoming:ro -v $PWD/out:/outgoing:rw -w /outgoing \
    localhost/fnndsc/pl-zerobg zb /incoming /outgoing

Testing

Run unit tests using pytest. It's recommended to rebuild the image to ensure that sources are up-to-date. Use the option --build-arg extras_require=dev to install extra dependencies for testing.

docker build -t localhost/fnndsc/pl-zerobg:dev --build-arg extras_require=dev .
docker run --rm -it localhost/fnndsc/pl-zerobg:dev pytest

Release

Steps for release can be automated by Github Actions. This section is about how to do those steps manually.

Increase Version Number

Increase the version number in setup.py and commit this file.

Push Container Image

Build and push an image tagged by the version. For example, for version 1.2.3:

docker build -t docker.io/fnndsc/pl-zerobg:1.2.3 .
docker push docker.io/fnndsc/pl-zerobg:1.2.3

Get JSON Representation

Run chris_plugin_info to produce a JSON description of this plugin, which can be uploaded to ChRIS.

docker run --rm docker.io/fnndsc/pl-zerobg:1.2.3 chris_plugin_info -d docker.io/fnndsc/pl-zerobg:1.2.3 > chris_plugin_info.json

Intructions on how to upload the plugin to ChRIS can be found here: https://chrisproject.org/docs/tutorials/upload_plugin