so-campaign-manager 0.0.4__py3-none-any.whl

so_campaign_manager-0.0.4.dist-info/METADATA

@@ -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

so_campaign_manager-0.0.4.dist-info/RECORD

@@ -0,0 +1,44 @@
+so_campaign_manager-0.0.4.dist-info/licenses/LICENSE,sha256=7DW9JsCHGLGy8TJS98-KWlrac-3hTg5bPi16w5Lmxmk,1307
+socm/__about__.py,sha256=QlXZ5JTjE_pgpDaeHk0GTExkc75xUZFmd0hA7kGYCJ0,704
+socm/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+socm/__main__.py,sha256=iNmFCkZS5ejtfFM6aL9k0xwXHSViDuf8oCZ0H2aYvJc,1014
+socm/bookkeeper/__init__.py,sha256=lGB8K4JnDwTWZyb8fCO82EMVqIBJcfFy68cJFy7M1Oc,49
+socm/bookkeeper/bookkeeper.py,sha256=rex-sZ-5eSeFuFCp5NLX-koNvO4sNCyJ0CSc2D4YNyI,20290
+socm/configs/slurmise.toml,sha256=2rSr4is8zbq4FPWyyc1iPrkCJ9G3dqAGx1Sw-btP2L4,83
+socm/core/__init__.py,sha256=uqKK2fu3-5HYXQa6xjSuzHH68UrHOYUVFG1MFFZ74JE,74
+socm/core/models.py,sha256=BvG7CUnBstYS62xYHkCZaRe9GezqVRr6MfKXsxr7V38,9249
+socm/enactor/__init__.py,sha256=uXqLBcZWpYx9cbk4AcB8OO9l8X2q47PkADEYLcG-XBc,144
+socm/enactor/base.py,sha256=ncqw52B_p_hkun8oneFYLmVmnpExoVggNkPsk5Ru6kI,4092
+socm/enactor/dryrun_enactor.py,sha256=iVlD0xB2O33PvhCUrXXIMTbSRoIS-SlpA_JJRDCExUo,8720
+socm/enactor/rp_enactor.py,sha256=scgPRlgcTR0v8PwlKd7WxlyYK0NF7t71Qcj6kWmA_CE,11344
+socm/execs/__init__.py,sha256=F2fZ8uQcxSaXxkiSht_olwXh76vJzSiKQI8GTUbS9ek,68
+socm/execs/mapmaking.py,sha256=Dz37qocv5wkpTDxO2IRNwtpB0KwVWWPuD_hl8v9wd9s,2770
+socm/planner/__init__.py,sha256=FSeIb_Qo1pElU4CZ1g2vlieCNlJogNkdwfftEvMr7fI,103
+socm/planner/base.py,sha256=3PK-FTmmQlnwBg4TlkEoWcKW0ywjMtPTBDWrb5faoBo,2999
+socm/planner/heft_planner.py,sha256=cEfWTK5M6KXaL2wPtW6BmVbzvXxkz4GepQ1cRdCN6nA,16863
+socm/resources/__init__.py,sha256=hJP9euCuUd7xJ9ekmcn-4V6AF4hQUqjpcbw3jzV8HhQ,271
+socm/resources/perlmutter.py,sha256=m2Qb5tgSON4f7T4XxBLDx8Yq9Qx0Ip_f-gyJtKBeopk,885
+socm/resources/tiger.py,sha256=p_yRSxKARdtuWgPVmXZaBXfdqJpSzkTINLwL5ZwMAX8,1026
+socm/resources/universe.py,sha256=B9ULdan2zaUoWOp0tdk_Og9qB0ZUZPwFGZ-FwoD4qOQ,557
+socm/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+socm/utils/misc.py,sha256=Tjyu3EPYP2QFiaEwXLQpLoUd4STpP6Ub0VCGLKStShg,3217
+socm/utils/states.py,sha256=pws0-BdCokuoHpMTk1E0uARCKN-Kwg5OtlqbmTOlf8s,618
+socm/workflows/__init__.py,sha256=S54_Q54sT22NRJLZLi9OsUm_pfLQn1gPq7mgjPNvfzY,1421
+socm/workflows/ml_mapmaking.py,sha256=bYQE27vO_jbYMPycpajBo3yQi4Tdw0GCQpt4GMqGKQ0,3711
+socm/workflows/sat_simulation.py,sha256=TgtqgeKVRL2nd2EAliPUuO1EmGSTOIudf1h46eMI-Ag,2589
+socm/workflows/ml_null_tests/__init__.py,sha256=se6_7OqqmXUkZDqVF4Ba5XJOW4yIdIP4U--jcBETi24,686
+socm/workflows/ml_null_tests/base.py,sha256=mk7QU2KU7LW7Ve--jZ2KAHB7xSGxDGTvSlNiSO2DdL8,4156
+socm/workflows/ml_null_tests/day_night_null_test.py,sha256=mI83eLnh_av_Ei4kTvNGgt7IiQVXttWNqy7YmzFatwE,5228
+socm/workflows/ml_null_tests/direction_null_test.py,sha256=crXB943jt7B5YQr2Zf7zrS9ZFFn4uw_P0RtYyUT7Jwg,5336
+socm/workflows/ml_null_tests/elevation_null_test.py,sha256=tAYlcp3edEefgYxGBOMTNs7mQpa2TovaduU0pnI8Tmg,4716
+socm/workflows/ml_null_tests/moon_close_null_test.py,sha256=e0RZYGMQ5goiIt-bmLcv1Ij83MMEi9C0nnsDOfWY7_c,6612
+socm/workflows/ml_null_tests/moonrise_set_null_test.py,sha256=iwOV--qh25RvyCsDhWBOEkotfMfo-Tl_6CRRUgVvKTg,6154
+socm/workflows/ml_null_tests/pwv_null_test.py,sha256=IFGD27ya_ABgfDpMW6LJf8LND8BjRzS_1jjVjB6CNHI,4660
+socm/workflows/ml_null_tests/sun_close_null_test.py,sha256=2OXYAwDezHtQu4flm7p3VpGwsgrDbwwyyW_cvqvhorE,6910
+socm/workflows/ml_null_tests/time_null_test.py,sha256=CvJs2c2__3SPwCpNOsnjsjdP7GAlsR9XAAs-uCGeWL8,2948
+socm/workflows/ml_null_tests/wafer_null_test.py,sha256=TyYikNz2R5MQpn8nA-qtqL-S_kRqJBEGV9Bpp0VYQPI,5924
+so_campaign_manager-0.0.4.dist-info/METADATA,sha256=vQReZHgGLbQ4PG1QZoSxUOjePP3uT9_3xCbbmYxHeaQ,7158
+so_campaign_manager-0.0.4.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+so_campaign_manager-0.0.4.dist-info/entry_points.txt,sha256=AOCAMD2Hlow7ANjC7x-y-hoIjpK0ZJHlzSlge1G8rbE,44
+so_campaign_manager-0.0.4.dist-info/top_level.txt,sha256=ZwRffSGa60j_n2D5eKpZYecNFY61dmaLEH98Ks_p7O0,5
+so_campaign_manager-0.0.4.dist-info/RECORD,,

so_campaign_manager-0.0.4.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

so_campaign_manager-0.0.4.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+socm = socm.__main__:main

so_campaign_manager-0.0.4.dist-info/licenses/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.dist-info/top_level.txt

@@ -0,0 +1 @@
+socm

socm/__about__.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.0.4'
+__version_tuple__ = version_tuple = (0, 0, 4)
+
+__commit_id__ = commit_id = None

socm/__main__.py

@@ -0,0 +1,35 @@
+from argparse import ArgumentParser, Namespace
+
+from socm.execs import SUBCOMMANDS
+
+
+def get_parser() -> ArgumentParser:
+    """Create and return the argument parser for the SO campaign."""
+    parser = ArgumentParser(description="Run the SO campaign.")
+    # Make sure all args here are redirected to vars starting with
+    # '_'.  We are going to clean those off before passing to the
+    # subcommand.
+    sps = parser.add_subparsers(dest='_pipemod', required=True)
+
+    for name, module in SUBCOMMANDS.items():
+        sp = sps.add_parser(name)
+        module.get_parser(sp)
+
+    return parser
+
+
+def main() -> None:
+    parser = get_parser()
+    args = parser.parse_args()
+
+    # Extract top-level args ...
+    top_args = {k: v for k, v in vars(args).items()
+                if k[0] == '_'}
+    for k in top_args:
+        delattr(args, k)
+    top_args = Namespace(**top_args)
+
+    module = SUBCOMMANDS[top_args._pipemod]
+    _main = getattr(module, '_main', None)
+    if _main is not None:
+        _main(args)

socm/bookkeeper/__init__.py

@@ -0,0 +1 @@
+from .bookkeeper import Bookkeeper  # noqa: F401