Guides for v0.1
Legacy documentation
This documentation is for the legacy version of CAREamics (v0.1), which is
accessible through the careamics.compat module. It is kept here for reference, but
we recommend using the latest version of CAREamics (v0.2) for new projects. Head to the v0.2 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.
-
CAREamist API (v0.1)
The recommended way to use CAREamics in a few lines of code to apply various methods in the most comfortable way possible.
-
Lightning API (v0.1)
Advanced users can re-use parts of CAREamics in their Lightning pipeline, with more customization potential available.
-
Developer resources (v0.1)
More details on how the documentation is set up, and guidelines for modifying and contributing to CAREamics.