Contributing

Package development and installation in Fractal

1. Install the package in dev mode with python -m pip install -e ".[dev]"
2. Develop the function according to the Fractal API
3. Update the image list and the Fractal manifest with python src/operetta_compose/dev/create_manifest.py
4. Build a wheel file in the dist folder of the package with python -m build
5. Collect the tasks on a Fractal server

Note

As Fractal task are Python function they can also be execute independently of Fractal e.g. by running

from operetta_compose.tasks.harmony_to_ome_zarr import harmony_to_ome_zarr

harmony_to_ome_zarr(
  img_path="operetta_plate/Images",
  zarr_dir="operetta_plate.zarr"
)

Updating the documentation

1. Make your changes to the documentation under /docs
2. Update the function API with quartodoc build
3. Preview the documentation with quarto preview