CIL-Reader-Showcase

A library of jupyter notebooks to showcase reading open-source CT datasets of a variety of formats. These notebooks have been contributed by users of the Core Imaging Library.

Install an environment to run the showcase locally

The easiest way to install an environment to run the showcase is using our maintained environment file which contains the required packages. Running the command below will create a new environment which has specific and tested versions of all CIL dependencies and additional packages required to run the showcase:

conda env create -f https://tomographicimaging.github.io/scripts/env/cil_demos.yml

Run the showcase locally

• Activate your environment using: conda activate cil-demos.

• Clone the CIL-Reader-Showcase repository and move into the CIL-Reader-Showcase folder.

• Run: jupyter-lab on the command line.

Contribution Guidelines

To contribute to the repository, create a fork of the repository and a new branch.

Create a notebook with a descriptive name containing the name of the data type and the sample it's working with.

If the reader your notebook will be using is not already in CIL, please contribute it to readers

If you would like to include any images in your demonstration please add them to images. Any image files should begin with your notebook's name.

All contributed files should have the Apache 2.0 License Header at the top, plus the name of the authors.

Please read and adhere to the developer guide and local patterns and conventions.

Please also: Add a description of your contribution(s) to the top of your file(s) Add a link to the publicly available dataset used near the top of the file(s) Add the CIL version you ran with near the top of the file(s) Mention in your PR if your reader requires any additional dependencies

When your contributions are ready, open a pull request for the CIL developer team to review! When you open the pull request please tick the box saying "Allow edits from maintainers".

The CIL developer team will then review your contribution and may ask for small changes or push some small changes to your fork.

If you wish to contribute a notebook, have any questions or want to find out more then please join the CIL community on Discord.