so-campaign-manager 0.2.0

SO Campaign Manager

This repository holds the code of the software tools that will run the mapmaking campaign on So resources.

The project has three big aspects:

1. Providing a method to submit new workflows, update existing ones and delete via configuration or a series of commands
2. Based on the workflow configuration set the resource requirement accordingly and submit it to SLURM. Resource configuration can be based on:
   1. Total size of observations and their file distribution
   2. A specific observation mapping between processes and files
   3. Node memory and node processor performance.
3. Use a workflow management tool to execute all workflows in the minimum amount of time.

Documentation

📚 Full Documentation - Complete documentation including:

• Installation Guide - Setup and installation instructions
• Quick Start - Get started quickly with examples
• User Guide - Comprehensive usage guide
• API Reference - Complete API documentation
• Workflow Guide - Available workflows and how to use them
• Developer Guide - Contributing and development setup

Building Documentation

To build the HTML documentation locally:

cd docs
pip install sphinx sphinx-rtd-theme
make html

The documentation will be available in docs/_build/html/index.html.

Quick Start

Install the package:

pip install so_campaign_manager

Create a configuration file (campaign.toml):

[campaign]
deadline = "2d"

[campaign.resources]
nodes = 4
cores-per-node = 112

[campaign.ml-mapmaking]
context = "file:///path/to/context.yaml"
output_dir = "/path/to/output"
bands = "f090"
# ... other parameters

Run your campaign:

socm -t campaign.toml

For detailed examples and configuration options, see the documentation.

For information on contributing, branching model, and code style requirements, see CONTRIBUTING.md.