IPA Project Template

Welcome to the Image Processing & Analysis Project Template. The project structure initialized by this template organizes data and software in a way that supports growth of your research project in size as well as in complexity without sacrificing clarity.

Example Project

Take a look at our example-project if you'd like to see the template in action!

Prerequisites

In our project template we use pixi.sh as environment manager and copier to generate a copy of the project template. The installation instructions for pixi can be found here. After successful installation of pixi and restarting your terminal, you can type pixi info to get the current version of pixi.

Update pixi

If you have installed pixi already, please make sure to update it to the latest version by running:

pixi self-update

Now install copier as a global package with pixi:

pixi global install copier

Generate an IPA Project with Copier

Copier will ask you a series of questions whose answers will be used to generate a tailored IPA project for you. To start the process run the following and replace my-ipa-project with the name of your project directory:

pixi x copier copy git+https://github.com/fmi-faim/ipa-project-template my-ipa-project

Congratulations!

You have created a new personalized IPA project! Now you can change into the project root-directory with

cd my-ipa-project

or open the directory in your file browser.