m4opt 2.1.0__tar.gz

m4opt-2.1.0/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly

m4opt-2.1.0/.github/workflows/ci_cron_weekly.yml

@@ -0,0 +1,46 @@
+# GitHub Actions workflow that runs on a cron schedule.
+
+name: Cron Scheduled CI Tests
+
+permissions: {}
+
+on:
+  schedule:
+    # run at 6am UTC on Mondays
+    - cron: '0 6 * * 1'
+
+jobs:
+  # Testing links in documents is a good example of something to run on a schedule
+  # to catch links that stop working for some reason.
+  cron_tests:
+    name: ${{ matrix.name }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - name: Check links in docs using tox
+            python: '3.11'
+            toxenv: linkcheck
+
+          - name: Python 3.11 with latest dev versions of key dependencies
+            python: '3.11'
+            toxenv: py311-test-devdeps
+
+    steps:
+    - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8  # v6.0.1
+    - name: Cache Astropy data
+      uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb  # v5.0.1
+      with:
+        key: ${{ matrix.toxenv }}
+        path: ~/.astropy/cache
+    - name: Set up python ${{ matrix.python }}
+      uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548  # v6.1.0
+      with:
+        cache: pip
+        python-version: ${{ matrix.python }}
+    - name: Install base dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install tox
+    - name: Test with tox
+      run: tox -e ${{ matrix.toxenv }}

m4opt-2.1.0/.github/workflows/ci_tests.yml

@@ -0,0 +1,112 @@
+# GitHub Actions workflow for testing and continuous integration.
+#
+# This file performs testing using tox and tox.ini to define and configure the test environments.
+
+name: CI Tests
+
+permissions: {}
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  types:
+    name: Python type checking
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8  # v6.0.1
+        with:
+          fetch-depth: 0
+      - name: Set up python
+        uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548  # v6.1.0
+        with:
+          cache: pip
+          python-version: "3.11"
+      - name: Run mypy
+        uses: python/mypy@v1.19.1
+  # Github Actions supports ubuntu, windows, and macos virtual environments:
+  # https://help.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners
+  ci_tests:
+    name: ${{ matrix.name }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          - name: Python 3.11 with minimal dependencies and coverage checking
+            os: ubuntu-latest
+            python: '3.11'
+            toxenv: py311-test-cov
+
+          - name: Python 3.11 with all optional dependencies and coverage checking
+            os: ubuntu-latest
+            python: '3.11'
+            toxenv: py11-test-alldeps-cov
+
+          # - name: OS X - Python 3.11 with all optional dependencies
+          #   os: macos-latest
+          #   python: '3.11'
+          #   toxenv: py311-test-alldeps
+
+          # - name: Windows - Python 3.11 with all optional dependencies
+          #   os: windows-latest
+          #   python: '3.11'
+          #   toxenv: py311-test-alldeps
+
+          - name: Python 3.11 with oldest supported version of all dependencies
+            os: ubuntu-22.04
+            python: '3.11'
+            toxenv: py311-test-oldestdeps
+
+          # - name: Python 3.11 with latest dev versions of key dependencies
+          #   os: ubuntu-latest
+          #   python: '3.11'
+          #   toxenv: py311-test-devdeps
+
+          # - name: Test building of Sphinx docs
+          #   os: ubuntu-latest
+          #   python: '3.11'
+          #   toxenv: build_docs
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8  # v6.0.1
+      with:
+        fetch-depth: 0
+    - name: Cache Astropy data
+      uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb  # v5.0.1
+      with:
+        key: ${{ matrix.toxenv }}
+        path: ~/.astropy/cache
+    - name: Set up python ${{ matrix.python }} on ${{ matrix.os }}
+      uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548  # v6.1.0
+      with:
+        cache: pip
+        python-version: ${{ matrix.python }}
+    - name: Install base dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install tox codecov
+
+    - name: Test with tox
+      env:
+        CPLEX_STUDIO_KEY: ${{ secrets.CPLEX_STUDIO_KEY }}
+        GRB_LICENSE_FILE_CONTENTS: ${{ secrets.GRB_LICENSE_FILE_CONTENTS }}
+      run: |
+        if [ -n "$GRB_LICENSE_FILE_CONTENTS" ]; then
+          printenv GRB_LICENSE_FILE_CONTENTS > $HOME/gurobi.lic
+        fi
+        tox -e ${{ matrix.toxenv }}
+
+    - name: Upload coverage to codecov
+      if: contains(matrix.toxenv, '-cov')
+      uses: codecov/codecov-action@5a1091511ad55cbe89839c7260b706298ca349f7  # v5.0.0-beta
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+
+    - name: Upload test results to Codecov
+      if: contains(matrix.toxenv, '-cov')
+      uses: codecov/test-results-action@47f89e9acb64b76debcd5ea40642d25a4adced9f  # v1.1.1
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}

m4opt-2.1.0/.github/workflows/publish.yml

@@ -0,0 +1,21 @@
+name: Publish
+
+permissions: {}
+
+on:
+  schedule:
+    # run every day at 4am UTC
+    - cron: '0 4 * * *'
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - main
+    tags:
+      - v*
+
+jobs:
+  publish:
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@9f1fedda61294df4c004c05519a3fbf3b8e1f32f  # v2.3.1
+    secrets:
+      pypi_token: ${{ secrets.pypi_token }}

m4opt-2.1.0/.gitignore

@@ -0,0 +1,70 @@
+# Compiled files
+*.py[cod]
+*.a
+*.o
+*.so
+__pycache__
+
+# Ignore .c files by default to avoid including generated code. If you want to
+# add a non-generated .c extension, use `git add -f filename.c`.
+*.c
+
+# Other generated files
+*/_version.py
+*/cython_version.py
+htmlcov
+.coverage
+.coverage.*
+MANIFEST
+.ipynb_checkpoints
+.hypothesis
+junit.xml
+
+# Sphinx
+docs/api
+docs/_build
+docs/guide/roman_wfi.ds9
+
+# Eclipse editor project files
+.project
+.pydevproject
+.settings
+
+# Pycharm editor project files
+.idea
+
+# Floobits project files
+.floo
+.flooignore
+
+# Visual Studio Code project files
+.vscode
+
+# Packages/installer info
+*.egg
+*.egg-info
+dist
+build
+eggs
+.eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+distribute-*.tar.gz
+
+# Other
+.cache
+.tox
+.*.sw[op]
+*~
+.project
+.pydevproject
+.settings
+pip-wheel-metadata/
+.tmp
+
+# Mac OSX
+.DS_Store

m4opt-2.1.0/.pre-commit-config.yaml

@@ -0,0 +1,44 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-case-conflict
+        # Check for files with names that would conflict on a case-insensitive
+        # filesystem like MacOS HFS+ or Windows FAT.
+      - id: check-json
+        # Attempts to load all json files to verify syntax.
+      - id: check-merge-conflict
+        # Check for files that contain merge conflict strings.
+      - id: check-symlinks
+        # Checks for symlinks which do not point to anything.
+      - id: check-toml
+        # Attempts to load all TOML files to verify syntax.
+      - id: check-xml
+        # Attempts to load all xml files to verify syntax.
+      - id: check-yaml
+        # Attempts to load all yaml files to verify syntax.
+      - id: detect-private-key
+        # Checks for the existence of private keys.
+      - id: end-of-file-fixer
+        # Makes sure files end in a newline and only a newline.
+      - id: trailing-whitespace
+        # Trims trailing whitespace.
+        exclude_types: [python] # Covered by Ruff W291.
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.14.10
+    hooks:
+      # Run the linter.
+      - id: ruff-check
+        args: ["--extend-select", "I", "--fix"]
+      # Run the formatter.
+      - id: ruff-format
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        args: ["--write-changes"]
+        additional_dependencies:
+          - tomli

m4opt-2.1.0/.readthedocs.yml

@@ -0,0 +1,21 @@
+version: 2
+
+build:
+  apt_packages:
+    - graphviz
+  os: ubuntu-24.04
+  tools:
+    python: '3.11'
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+        - all
+
+sphinx:
+  configuration: docs/conf.py
+
+formats: []

m4opt-2.1.0/CHANGES.rst

@@ -0,0 +1,68 @@
+*******
+Changes
+*******
+
+2.1.0 (2025-12-31)
+==================
+
+- Add the method ``m4opt.milp.Model.to_stream``.
+
+- Add the method ``m4opt.utils.optimization.partition_graph_color``.
+
+2.0.1 (2025-06-12)
+==================
+
+- Allow passing any options to METIS.
+
+2.0.0 (2025-06-09)
+==================
+
+- Allow each mission to have one or several different sky grids.
+
+- Add support for combining constraints using boolean operators
+  (``lhs | rhs``, ``lhs & rhs``, ``~op``).
+
+- The ``Mission.constraints`` property no longer accepts a list of constraints.
+  To combine multiple constraints, use boolean operators.
+
+- The ``Mission.detector`` property is now optional. Only adaptive exposure
+  time observing strategies require it to be defined.
+
+- Add Earth radiation belt constraint.
+
+- Add two new missions: Vera C. Rubin Observatory and Zwicky Transient
+  Facility.
+
+- Add a mixed integer programming Traveling Salesman solver.
+
+1.0.0 (2025-04-07)
+==================
+
+- Add citation file.
+
+- Refactor obsever position classes to support both Earth-fixed and
+  Earth-orbiting observers.
+
+- Add basic positional astronomy constraints on right ascension, declination,
+  altitutide, azimuth, and airmass.
+
+- Add at-night constraint for Earth-fixed observers.
+
+- Add logical constraints (and, or, not).
+
+- Add an exact Traveling Salesman solver as a utility function.
+
+- Move the DustExtinction class to the m4opt.synphot.extinction module
+  to prepare for adding other sources of extinction (e.g., atmospheric).
+
+- Add optional zoom inset to animation.
+
+0.1.1 (2025-02-24)
+==================
+
+- Update PyPI long description. No functional changes in this release.
+
+0.1.0 (2025-02-24)
+==================
+
+- First release.

m4opt-2.1.0/CITATION.cff

@@ -0,0 +1,100 @@
+cff-version: 1.2.0
+message: Please cite the following works when using this software.
+type: software
+abstract: Multi-Mission Multi-Messenger Observation Planning Toolkit
+authors:
+  - family-names: Singer
+    given-names: Leo
+  - name: pre-commit-ci[bot]
+  - name: dependabot[bot]
+  - family-names: Parazin
+    given-names: B
+  - family-names: Tollerud
+    given-names: Erik
+  - family-names: Bard
+    given-names: Chris
+  - family-names: Healy
+    given-names: Brian
+  - family-names: Bellm
+    given-names: Eric
+  - family-names: Kiendrébéogo
+    given-names: Ramodgwendé Weizmann
+  - family-names: Wagh
+    given-names: Yogesh
+date-released: 2025-02-24
+identifiers:
+  - type: url
+    value: https://github.com/m4opt/m4opt
+title: m4opt/m4opt
+url: https://github.com/m4opt/m4opt
+version: v0.1.1
+preferred-citation:
+  abstract: >-
+    The UltraViolet EXplorer (UVEX) is a wide-field ultraviolet space telescope
+    selected as a NASA Medium-Class Explorer (MIDEX) mission for launch in 2030.
+    UVEX will undertake deep, cadenced surveys of the entire sky to probe low
+    mass galaxies and explore the ultraviolet (UV) time-domain sky, and it will
+    carry the first rapidly deployable UV spectroscopic capability for a broad
+    range of science applications. One of UVEX's prime objectives is to follow
+    up gravitational wave (GW) binary neutron star mergers as targets of
+    opportunity (ToOs), rapidly scanning across their localization regions to
+    search for their kilonova (KN) counterparts. Early-time multiband
+    ultraviolet light curves of KNe are key to explaining the interplay between
+    jet and ejecta in binary neutron star mergers. Owing to high Galactic
+    extinction in the ultraviolet and the variation of GW distance estimates
+    over the sky, the sensitivity to kilonovae can vary significantly across the
+    GW localization and even across the footprint of a single image given UVEX's
+    large field of view. Good ToO observing strategies to trade off between area
+    and depth are neither simple nor obvious. We present an optimal strategy for
+    GW follow-up with UVEX in which exposure time is adjusted dynamically for
+    each field individually to maximize the overall probability of detection. We
+    model the scheduling problem using the expressive and powerful mathematical
+    framework of mixed integer linear programming (MILP), and employ a
+    state-of-the-art MILP solver to automatically generate observing plan
+    timelines that achieve high probabilities of kilonova detection. We have
+    implemented this strategy in an open-source astronomical scheduling software
+    package called the Multi-Mission Multi-Messenger Observation Planning
+    Toolkit (M4OPT), on GitHub at https://github.com/m4opt/m4opt.
+  authors:
+    - family-names: Singer
+      given-names: Leo P.
+    - family-names: Criswell
+      given-names: Alexander W.
+    - family-names: Leggio
+      given-names: Sydney C.
+    - family-names: Kiendrebeogo
+      given-names: R. Weizmann
+    - family-names: Coughlin
+      given-names: Michael W.
+    - family-names: Earnshaw
+      given-names: Hannah P.
+    - family-names: Gezari
+      given-names: Suvi
+    - family-names: Grefenstette
+      given-names: Brian W.
+    - family-names: Harrison
+      given-names: Fiona A.
+    - family-names: Kasliwal
+      given-names: Mansi M.
+    - family-names: Morris
+      given-names: Brett M.
+    - family-names: Tollerud
+      given-names: Erik
+    - family-names: Cenko
+      given-names: S. Bradley
+  doi: 10.48550/ARXIV.2502.17560
+  identifiers:
+    - type: doi
+      value: 10.48550/ARXIV.2502.17560
+    - type: url
+      value: https://arxiv.org/abs/2502.17560
+  title: >-
+    Optimal Follow-Up of Gravitational-Wave Events with the UltraViolet EXplorer
+    (UVEX)
+  url: https://arxiv.org/abs/2502.17560
+  version: '1'
+  date-published: 2025-01-01
+  year: 2025
+  publisher:
+    name: arXiv
+  type: article

m4opt-2.1.0/MANIFEST.in

@@ -0,0 +1,10 @@
+recursive-include m4opt *.pyx *.c *.pxd
+recursive-include docs *
+recursive-include licenses *
+recursive-include scripts *
+
+prune build
+prune docs/_build
+prune docs/api
+
+global-exclude *.pyc *.o

m4opt-2.1.0/PKG-INFO

@@ -0,0 +1,163 @@
+Metadata-Version: 2.4
+Name: m4opt
+Version: 2.1.0
+Summary: Multi-Mission Multi-Messenger Observation Planning Toolkit
+Author-email: M4OPT Developers <leo.singer@ligo.org>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://m4opt.readthedocs.io/
+Project-URL: Bug Tracker, https://github.com/m4opt/m4opt/issues
+Project-URL: Change Log, https://m4opt.readthedocs.io/en/latest/changes.html
+Project-URL: Documentation, https://m4opt.readthedocs.io/
+Project-URL: GitHub, https://github.com/m4opt/m4opt
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+Requires-Dist: aep8
+Requires-Dist: antiprism-python
+Requires-Dist: astropy>=7.1.0
+Requires-Dist: astropy-healpix
+Requires-Dist: astroquery
+Requires-Dist: click>=8.2.0
+Requires-Dist: cplex
+Requires-Dist: docplex
+Requires-Dist: dust-extinction
+Requires-Dist: dustmaps
+Requires-Dist: ligo.skymap>=2.4.0
+Requires-Dist: networkx
+Requires-Dist: numpy>=2.1.0
+Requires-Dist: regions
+Requires-Dist: pymetis
+Requires-Dist: satellitetle
+Requires-Dist: scipy
+Requires-Dist: sgp4
+Requires-Dist: spiceypy
+Requires-Dist: sympy
+Requires-Dist: synphot
+Requires-Dist: typer>=0.16.0
+Requires-Dist: typing_extensions; python_version < "3.12"
+Requires-Dist: xdg-base-dirs
+Provides-Extra: test
+Requires-Dist: astroplan; extra == "test"
+Requires-Dist: networkx; extra == "test"
+Requires-Dist: sphinxcontrib-bibtex; extra == "test"
+Requires-Dist: pytest-astropy; extra == "test"
+Provides-Extra: docs
+Requires-Dist: pysiaf; extra == "docs"
+Requires-Dist: sphinx-astropy[confv2]; extra == "docs"
+Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
+Requires-Dist: sphinxcontrib-typer; extra == "docs"
+
+Multi-Mission Multi-Messenger Observation Planning Toolkit
+----------------------------------------------------------
+
+.. image:: https://img.shields.io/pypi/v/m4opt
+    :target: https://pypi.org/project/m4opt/
+    :alt: Python Package Index status
+.. image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
+    :target: http://www.astropy.org
+    :alt: Powered by Astropy Badge
+.. image:: https://codecov.io/gh/m4opt/m4opt/branch/main/graph/badge.svg?token=L837JHNTUV
+    :target: https://codecov.io/gh/m4opt/m4opt
+    :alt: Code coverage status
+.. image:: https://readthedocs.org/projects/m4opt/badge/?version=latest
+    :target: https://m4opt.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+.. image:: https://m4opt.readthedocs.io/en/latest/_images/example.gif
+    :alt: Visualization of an example observing plan for UVEX generated M4OPT
+
+M4OPT is an open-source toolkit for multi-facility scheduling of astrophysics
+observing campaigns. It focuses on extremely rapid follow-up of gravitational
+wave (GW) and neutrino events with heterogeneous networks of space and
+ground-based observatories.
+
+M4OPT uses the versatile mathematical framework of `mixed integer
+programming`__ to model and solve complex observation scheduling problems.
+Although M4OPT is open source, for the largest problems it can leverage two
+industrial-strength commercial MIP solvers: `CPLEX`__ or `Gurobi`__. Both
+solvers are available for free for academic users.
+
+__ https://en.wikipedia.org/wiki/Integer_programming
+__ https://www.ibm.com/products/ilog-cplex-optimization-studio
+__ https://www.gurobi.com
+
+M4OPT is designed from the `Astropy affiliated package`__ template, and is
+meant to follow those standards, including interoperability with the
+`Astropy`__ ecosystem. It also complies with `NASA Procedural Requirements
+(NPR) 7150`__ for `Class C software`__ and is suitable for non-safety-critical
+ground software applications for `Class D NASA payloads`__.
+
+__ https://www.astropy.org/affiliated/
+__ https://www.astropy.org
+__ https://nodis3.gsfc.nasa.gov/displayDir.cfm?t=NPR&c=7150&s=2C
+__ https://nodis3.gsfc.nasa.gov/displayDir.cfm?Internal_ID=N_PR_7150_002C_&page_name=AppendixD
+__ https://nodis3.gsfc.nasa.gov/displayDir.cfm?t=NPR&c=8705&s=4A
+
+Features
+--------
+
+*   **Global**: jointly and globally solves the problems of tiling (the set of
+    telescope boresight orientations and roll angles) and the scheduling (which
+    tile is observed at what time), rather than solving each sub-problem one at
+    a time
+*   **Optimal**: generally solves all the way to optimality, rather than
+    finding merely a "good enough" solution
+*   **Fast**: solve an entire orbit in about 5 minutes
+*   **General**: does not depend on heuristics of any kind
+*   **Flexible**: problem is formulated in the versatile framework of
+    `mixed integer programming <https://en.wikipedia.org/wiki/Integer_programming>`_
+
+License
+-------
+
+This project is Copyright (c) M4OPT Developers and licensed under
+the terms of the BSD 3-Clause license. This package is based upon
+the `Astropy package template <https://github.com/astropy/package-template>`_
+which is licensed under the BSD 3-clause license. See the licenses folder for
+more information.
+
+How to Cite
+-----------
+
+If you use M4OPT in your research, then please cite the following paper:
+
+   Singer, L. P., Criswell, A. W., Leggio, S. C., et al. (2025). Optimal Follow-Up of Gravitational-Wave Events with the UltraViolet EXplorer (UVEX) (Version 1). https://doi.org/10.48550/ARXIV.2502.17560
+
+Contributing
+------------
+
+We love contributions! m4opt is open source,
+built on open source, and we'd love to have you hang out in our community.
+
+**Imposter syndrome disclaimer**: We want your help. No, really.
+
+There may be a little voice inside your head that is telling you that you're not
+ready to be an open source contributor; that your skills aren't nearly good
+enough to contribute. What could you possibly offer a project like this one?
+
+We assure you - the little voice in your head is wrong. If you can write code at
+all, you can contribute code to open source. Contributing to open source
+projects is a fantastic way to advance one's coding skills. Writing perfect code
+isn't the measure of a good developer (that would disqualify all of us!); it's
+trying to create something, making mistakes, and learning from those
+mistakes. That's how we all improve, and we are happy to help others learn.
+
+Being an open source contributor doesn't just mean writing code, either. You can
+help out by writing documentation, tests, or even giving feedback about the
+project (and yes - that includes giving feedback about the contribution
+process). Some of these contributions may be the most valuable to the project as
+a whole, because you're coming to the project with fresh eyes, so you can see
+the errors and assumptions that seasoned contributors have glossed over.
+
+Note: This disclaimer was originally written by
+`Adrienne Lowe <https://github.com/adriennefriend>`_ for a
+`PyCon talk <https://www.youtube.com/watch?v=6Uj746j9Heo>`_, and was adapted by
+m4opt based on its use in the README file for the
+`MetPy project <https://github.com/Unidata/MetPy>`_.