Skip to content
  • Guides
  • Guides

Guides#

CAREamics can be used in two ways, the recommended way is to use the CAREamist API, as it made to be simple, intuitive and minimize potential errors. Advanced users might want to only use parts of CAREamics in their own pipeline, for this they should refer to the Lightning API.

We also provide a command-line interface and developer resources!

CAREamist API

The recommended way to use CAREamics in a few lines of code to apply various methods in the most comfortable way possible.

Lightning API

Advanced users can re-use parts of CAREamics in their Lightning pipeline, with more customization potential available.

napari plugin

A UI interface for CAREamics in the popular napari image viewer, allowing training, predicting and saving models on your own data.

Tutorials

Thematic tutorials on various ways to use and apply CAREamics algorithms, from data inspection to using CAREamics in other tools.

Command-line interface

Want to run CAREamics from the command line, on your machine, remotely or on a cluster? Head this way!

Developer resources

More details on how the documentation is set up, and guidelines for modifying and contributing to CAREamics.