ASOkai documentation
Welcome to the official documentation for the ASOkai library.
If you’re new to the project, follow the installation instructions, then read the Getting Started guide. The pipeline reference describes the available steps. The API sections below document the public Python interface.
User Guide
Pipeline Reference
Contributor Guide
- Adding an analysis step
- What you are building
- Before you start
- Step 1: choose your two base classes
- What each base class gives you
- Step 2: write the analysis class
- Step 3: write the step class
- Step 4: connect inputs and outputs
- Step 5: parameters and configuration
- Step 6: register and document
- Step 7: write tests
- Step 8: check your work
- Worked example: an output that is not a CSV
- The template
- Generated reference documentation
- Publishing a plugin instead
- Pipeline components
- Internal steps
Project Info