so-campaign-manager 0.0.4__tar.gz

so_campaign_manager-0.0.4/.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 90
+extend-ignore = E203

so_campaign_manager-0.0.4/.gitattributes

@@ -0,0 +1 @@
+src/socm/_version.py export-subst

so_campaign_manager-0.0.4/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

so_campaign_manager-0.0.4/.github/workflows/lint.yaml

@@ -0,0 +1,17 @@
+name: Formatting
+permissions:
+  contents: read
+  pull-requests: write
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/ruff-action@v3
+        with:
+          src: "./src"
+      - uses: isort/isort-action@master
+        continue-on-error: true

so_campaign_manager-0.0.4/.github/workflows/release.yaml

@@ -0,0 +1,31 @@
+name: Release Campaign Manager
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

so_campaign_manager-0.0.4/.github/workflows/test.yaml

@@ -0,0 +1,23 @@
+name: Tests
+permissions:
+  contents: read
+  pull-requests: write
+
+on: [push, pull_request]
+
+jobs:
+  Test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+          cache: "pip"
+      - run: |
+             pip install https://github.com/simonsobs/sotodlib/archive/master.tar.gz
+             pip install -e ".[dev]"
+             pytest -vvv tests/ --cov --cov-append
+      - uses: coverallsapp/github-action@v2
+        with:
+          file: .coverage

so_campaign_manager-0.0.4/.gitignore

@@ -0,0 +1,169 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# VSCode
+.vscode/
+
+# Custom
+tmpdev/
+
+# setuptools-scm generated version file
+src/socm/__about__.py

so_campaign_manager-0.0.4/.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+repos:
+  - repo: https://github.com/pycqa/isort
+    rev: 6.0.1
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.12.5
+    hooks:
+      - id: ruff
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-added-large-files
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: debug-statements
+
+# Replace commitsar with conventional commit checker
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v2.1.1
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+        args: [] # default: [feat, fix, ci, chore, docs, style, refactor, perf, test, build, revert]

so_campaign_manager-0.0.4/.readthedocs.yaml

@@ -0,0 +1,15 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py

so_campaign_manager-0.0.4/CONTRIBUTING.md

@@ -0,0 +1,59 @@
+# Contributing to SO Campaign Manager
+
+Thank you for your interest in contributing to SO Campaign Manager! This document provides guidelines for contributing to the project.
+
+## Quick Start
+
+For detailed contributing guidelines, please see our **[Developer Guide](docs/developer_guide.rst)**.
+
+## Development Setup
+
+1. **Fork and clone** the repository
+2. **Set up development environment**:
+   ```bash
+   python -m venv env
+   source env/bin/activate  # On Windows: env\Scripts\activate
+   pip install -e ".[dev]"
+   ```
+3. **Install pre-commit hooks** (optional but recommended):
+   ```bash
+   pip install pre-commit
+   pre-commit install
+   ```
+
+## Code Standards
+
+- **PEP8 compliance is mandatory** - use `flake8` to check
+- **Optional formatting** with `darker` for progressive formatting
+- **Write tests** for new functionality
+- **Document your code** with Google-style docstrings
+
+## Pull Request Process
+
+1. Create a feature branch from `main`
+2. Make your changes with appropriate tests
+3. Ensure tests pass and code style is correct
+4. Submit a pull request with a clear description
+
+## Documentation
+
+- All public APIs should be documented
+- Update relevant documentation for changes
+- Build docs locally: `cd docs && make html`
+
+## Getting Help
+
+- 📚 **[Full Documentation](docs/index.rst)** - Complete guides and API reference
+- 🐛 **[GitHub Issues](https://github.com/simonsobs/so_campaign_manager/issues)** - Bug reports and feature requests
+- 💬 **[GitHub Discussions](https://github.com/simonsobs/so_campaign_manager/discussions)** - Questions and general discussion
+
+## Types of Contributions
+
+We welcome:
+- 🐛 Bug fixes
+- ✨ New features
+- 📝 Documentation improvements
+- 🧪 Test improvements
+- 🔧 Performance optimizations
+
+For detailed information about development workflow, code style, testing, and more, please refer to our **[Developer Guide](docs/developer_guide.rst)**.

so_campaign_manager-0.0.4/LICENSE

@@ -0,0 +1,24 @@
+BSD 2-Clause License
+
+Copyright (c) 2025, Simons Observatory
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

so_campaign_manager-0.0.4/MANIFEST.in

@@ -0,0 +1,3 @@
+include MANIFEST.in README.md
+
+recursive-include src      *.toml

so_campaign_manager-0.0.4/PKG-INFO

@@ -0,0 +1,179 @@
+Metadata-Version: 2.4
+Name: so_campaign_manager
+Version: 0.0.4
+Summary: A campaign manager to execute SO mapmaking campaign
+Author-email: Giannis Paraskevakos <iparask@princeton.edu>
+Requires-Python: <3.13,>=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: pydantic>=2.0
+Requires-Dist: radical.pilot; sys_platform != "darwin"
+Requires-Dist: networkx
+Requires-Dist: toml
+Requires-Dist: click
+Requires-Dist: sotodlib
+Requires-Dist: astral
+Requires-Dist: slurmise; sys_platform != "darwin"
+Requires-Dist: humanfriendly
+Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: darker; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: pytest-cov>=2.6; extra == "dev"
+Requires-Dist: coveralls>=1.5; extra == "dev"
+Requires-Dist: pytest>=4.6; extra == "dev"
+Requires-Dist: hypothesis; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: taskipy; extra == "dev"
+Requires-Dist: types-networkx; extra == "dev"
+Requires-Dist: types-pytz; extra == "dev"
+Requires-Dist: types-toml; extra == "dev"
+Requires-Dist: types-mock; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx_rtd_theme; extra == "docs"
+Requires-Dist: sphinxcontrib-napoleon; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
+Requires-Dist: myst-parser; extra == "docs"
+Dynamic: license-file
+
+[![PyPI - Version](https://img.shields.io/pypi/v/so_campaign_manager.svg)](https://pypi.org/project/so_campaign_manager)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/so_campaign_manager.svg)](https://pypi.org/project/so_campaign_manager)
+![CI workflow](https://github.com/simonsobs/so_campaign_manager/actions/workflows/test.yaml/badge.svg)
+[![Coverage Status](https://coveralls.io/repos/github/simonsobs/so_campaign_manager/badge.svg?branch=main)](https://coveralls.io/github/simonsobs/so_campaign_manager?branch=main)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15784156.svg)](https://doi.org/10.5281/zenodo.15784156)
+[![Docs Status](https://readthedocs.org/projects/so-campaign-manager/badge/?version=latest&style=flat)](https://so-campaign-manager.readthedocs.io)
+
+
+## SO Campaign Manager
+
+This repository holds the code of the software tools that will run the mapmaking campaign on Tiger 3.
+
+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](docs/index.rst)** - Complete documentation including:
+
+- [Installation Guide](docs/installation.rst) - Setup and installation instructions
+- [Quick Start](docs/quickstart.rst) - Get started quickly with examples
+- [User Guide](docs/user_guide.rst) - Comprehensive usage guide
+- [API Reference](docs/api.rst) - Complete API documentation
+- [Workflow Guide](docs/workflows.rst) - Available workflows and how to use them
+- [Developer Guide](docs/developer_guide.rst) - Contributing and development setup
+
+### Building Documentation
+
+To build the HTML documentation locally:
+
+```bash
+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:
+
+```bash
+pip install so_campaign_manager
+```
+
+Create a configuration file (`campaign.toml`):
+
+```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:
+
+```bash
+socm -t campaign.toml
+```
+
+For detailed examples and configuration options, see the [documentation](docs/).
+
+---
+
+## Development guide
+
+### Branching model
+
+* the latest development is in the `main` branch.
+* bug fixes:
+  * branch of `main`, naming convention: `fix/issue_1234` (reference github issue). `hotfix/issue_1234` if it is a major issue that needs resolution as soon as possible.
+  * fix in that branch, and test
+  * create pull request toward `main`
+  * code review, then merge
+* major development activities go into feature branches
+  * branch `main` into `feature/feature_name`
+  * work on that feature branch
+  * on completion, merge `main` into the feature branch.
+  * test the feature branch
+  * create a pull request for merging the feature branch into `main` (that should be a fast-forward now)
+  * merging of feature branches into `main` should be only after code review
+* documentation changes are handled like fix or feature branches, depending on size and impact, similar to code changes
+
+#### Branch Naming
+
+ * `main`: *never* commit directly
+ * `feature/abc`: development of new features
+ * `fix/abc_123`: referring to ticket 123
+ * `hotfix/abc_123`: referring to ticket 123, to be released right after merge to master
+ * `tmp/abc`: temporary branch, will be deleted soon
+ * `test/abc`: test some integration, like a merge of two feature branches
+
+For the latter: assume you want to test how `feature/a` works in combination with `feature/b`, then:
+ * `git checkout feature/a`
+ * `git checkout -b test/a_b`
+ * `git merge feature/b`
+ * do tests
+
+#### Branching Policies
+
+All branches are short living. To support this, only a limited number of branches should be open at any point in time. Only `N` branches for fixes and `M << N` branches for features should be open for each developer - other features / issues have to wait.
+
+
+### Ensure PEP8 compliance (mandatory) and format your code with Darker (optional)
+
+`darker` is a *partial formatting* tool that helps to reformat new or modified code lines so the codebase progressively adapts a code style instead of doing a full reformat, which would be a big commitment. It was designed with the ``black`` formatter in mind, hence the name.
+
+In this repo **we only require PEP8 compliance**, so if you want to make sure that your PR passes the darker bot, you'll need both darker and `flake8`:
+
+    pip install darker flake8
+
+
+You'll also need the original codebase so darker can first get a diff between the current ``develop`` branch and your code.
+After making your changes to your local branch, check your modifications on the package:
+
+    darker --diff -r origin/develop package/src -L flake8
+
+Darker will first suggest changes so that the new code lines comply with ``black``'s rules, and then show flake8 errors and warnings.
+
+You are free to skip the diffs and then manually fix the PEP8 faults.
+Or if you're ok with the suggested formatting changes, just apply the suggested fixes: ::
+
+    darker -r origin/develop package/scr -L flake8