Skip to content

Latest commit

 

History

History
109 lines (74 loc) · 3.25 KB

README.md

File metadata and controls

109 lines (74 loc) · 3.25 KB
Raw

Flip

Version MIT License ci

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

Abstract

Simple tool to flip images vertically or horizontally as specified by argument

Installation

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

Get it from chrisstore.co

Local Usage

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

singularity exec docker://bn222/pl-flip flip [--args values...] input/ output/

To print its available options, run:

singularity exec docker://bn222/pl-flip flip --help

Examples

flip requires three positional arguments: a direction (set to horizontal, vertical or both), 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/
singularity exec docker://bn222/pl-flip:latest flip DIRECTION incoming/ outgoing/

Building

Build a local container image:

docker build -t localhost/bn222/pl-flip .

Running

Mount the source code flip.py into a container to try out changes without rebuild. The argument "both" can be replaced by "horizontal" or "vertical".

docker run --rm -it --userns=host -u $(id -u):$(id -g) \
    -v $PWD/flip.py:/usr/local/lib/python3.10/site-packages/flip.py:ro \
    -v $PWD/in:/incoming:ro -v $PWD/out:/outgoing:rw -w /outgoing \
    localhost/bn222/pl-flip flip both /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/bn222/pl-flip:dev --build-arg extras_require=dev .
docker run --rm -it localhost/bn222/pl-flip: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/bn222/pl-flip:1.2.3 .
docker push docker.io/bn222/pl-flip:1.2.3

Get JSON Representation

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

docker run --rm localhost/bn222/pl-flip:dev chris_plugin_info > chris_plugin_info.json