Development

This section is for contributors. If you’re just using the library, see Getting Started and How-To Guides.

For contributors:

• Development Setup
  • Clone the Repository
  • Install Development Environment
  • Pre-commit Hooks
  • Managing Dependencies
  • Running Tests
  • Building Documentation
  • Next Steps
• Debugging
• Debug Unittests
• Debug a cloud optimised pipeline
• Testing
  • Testing the MCP Server
  • Prerequisites
  • Test Tiers and CLI Flags
  • Running the Tests
  • Test Classes
  • End-to-End Scenarios
  • Adding New Tests
• Building Documentation
  • Documentation Structure
  • Documentation Standards
  • Common Tasks
  • ReadTheDocs Integration
• Creating a Release
  • How to trigger a release
  • What the workflow does
  • Installing a released wheel
  • Updating the version manually (if needed)

Quick start for developers

1. Clone and install: git clone ... && make dev

2. Run pre-commit: poetry run pre-commit install

3. See Development Setup for full setup options

4. Run tests: make tests or pytest test_aodn_cloud_optimised/

5. Build docs: make docs then open build/html/index.html

6. Debug code: Use import ipdb; ipdb.set_trace() (see Debugging)

7. Before pushing: poetry run pre-commit run --all-files

Contributing workflow

1. Create a feature branch: git checkout -b feature/my-feature

2. Make changes and test locally: make tests

3. Update documentation if needed: Building Documentation

4. Run pre-commit: poetry run pre-commit run --all-files

5. Submit a pull request

See individual guides below for detailed information on each task.