Remi Detector Calculation for Monitoring Electrons

GUI tool to simulate Reaction Microscope detector images.

Try out the examples:

Example Outputs

Usage

With uv (recommended)

[!WARNING] You currently have to use your system python with included tkinter library (e.g. apt install python3-tk). uv apparently can not bring a working tk library. (Until https://github.com/astral-sh/python-build-standalone/pull/676 is merged) If you can not get tk to run, you can try to follow the "For developers" section. You would notice something like ImportError: module '_tkinter' has no attribute '__file__'.

Try out with temporary python environment:

uvx redcamel

Permanently install in isolated python environment:

uv tool install redcamel

Run:

redcamel

Upgrade

uv tool upgrade redcamel

uv can be found here: https://docs.astral.sh/uv/getting-started/installation/

With pipx (recommended)

Install in isolated python environment:

pipx install redcamel

Run:

redcamel

Update:

pipx upgrade redcamel

pipx can be found here: https://pipx.pypa.io/latest/installation/

With pip

Installing in your current python environment:

Install:

pip install redcamel

Run:

redcamel

Update:

pip install --upgrade redcamel

With conda/mamba/pixi

Not yet implemented, sorry..

Authors

• Initial implementation by Patrizia Schoch
• Maintained by Hannes Lindenblatt

For developers

First get the repository:

git clone https://codeberg.org/FlashREMI/RedCamel.git

or if you have an codeberg.org account with an ssh key set up:

git clone ssh://git@codeberg.org/FlashREMI/RedCamel.git

Then work inside the RedCamel folder. uv or pixi will find their configuration files there. You might need to get the image files with git-lfs:

git lfs install
git lfs pull

Usage with pixi (recommended)

[!TIP] pixi / the conda-forge python distribution actually includes tk libraries so you do not need installed system tk :)

pixi can be found here: https://pixi.sh/latest/#installation If you are on a cluster like DESYs maxwell, check if you can load pixi from a module like this:

module load maxwell pixi

Check the available pixi tasks!

pixi task list

Run tasks like this, e.g. the RedCamel:

pixi run redcamel

Usage with uv

uv run redcamel

uv can be found here: https://docs.astral.sh/uv/getting-started/installation/

Usage with venv + pip

Set up and activate a virtual environment:

python3 -m venv .venv
source .venv/bin/activate

Install redcamel in development mode:

pip install -e ./

Usage with mamba / conda

Setup

• install environment with dependencies:

mamba env create

Usage

• activate environment:

mamba activate redcamel

• run GUI with:

python src/redcamel/remi_gui.py

• Play around with plots and sliders!

Updating

• pull changes:

git pull

• update environment:

mamba activate redcamel
mamba env update