---

[]

MAAP Project

Tools for registering and managing algorithms in MAAP

[]

The MAAP Project provides tools for managing and registering algorithms with the MAAP API. This includes functionalities for searching granules, submitting and managing jobs, as well as handling results and metrics. The tools are typically used by scientists and researchers working with Earth observation data.

Example links: Website | Docs/Wiki | Discussion Board | Issue Tracker

Features

• Register algorithms with MAAP
• Search granules and collections
• Submit, track, and manage jobs
• Retrieve and visualize job results and metrics

Contents

• Quick Start
• Changelog
• FAQ
• Contributing Guide
• License
• Support

Quick Start

This guide provides a quick way to get started with our project. Please see our docs for a more comprehensive overview.

Requirements

• Python 3.x
• Requests library
• YAML library

Setup Instructions

1. Clone the repository.

   git clone https://github.com/your_org/your_repo.git

2. Install dependencies.

   pip install -r requirements.txt

3. Set up environment variables.

   export MAAP_HOST='api.your-maap-host.org'
   export MAAP_PGT='your-proxy-granting-ticket'

Run Instructions

1. Execute the main script.

   python main.py

2. To register an algorithm, use the following command.

   python main.py --register_algo path/to/algo_config.yaml

Usage Examples

• Register an algorithm via CLI:

  python main.py --register_algo path/to/algo_config.yaml

• Submit a job:

  python main.py --submit_job --algo_id "your_algo_id" --version "v1.0"

Build Instructions (if applicable)

1. Optional build step for creating a Docker image:

   docker build -t your-image-name .

Test Instructions (if applicable)

1. Run unit tests:

   pytest tests/

Changelog

See our CHANGELOG.md for a history of our changes.

See our releases page for our key versioned releases.

Frequently Asked Questions (FAQ)

Questions about our project? Please see our: FAQ

Contributing

Interested in contributing to our project? Please see our: CONTRIBUTING.md

For guidance on how to interact with our team, please see our code of conduct located at: CODE_OF_CONDUCT.md

For guidance on our governance approach, including decision-making process and our various roles, please see our governance model at: GOVERNANCE.md

License

See our: LICENSE

Support

Key points of contact are: @github-user-1 @github-user-2