m4opt 0.1.0__tar.gz

m4opt-0.1.0/.github/dependabot.yml

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

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

@@ -0,0 +1,44 @@
+# GitHub Actions workflow that runs on a cron schedule.
+
+name: Cron Scheduled CI Tests
+
+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@v4
+    - name: Cache Astropy data
+      uses: actions/cache@v4
+      with:
+        key: ${{ matrix.toxenv }}
+        path: ~/.astropy/cache
+    - name: Set up python ${{ matrix.python }}
+      uses: actions/setup-python@v5
+      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-0.1.0/.github/workflows/ci_tests.yml

@@ -0,0 +1,110 @@
+# 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
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  types:
+    name: Python type checking
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up python
+        uses: actions/setup-python@v5
+        with:
+          cache: pip
+          python-version: "3.11"
+      - name: Run mypy
+        uses: python/mypy@v1.15.0
+  # 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-20.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@v4
+      with:
+        fetch-depth: 0
+    - name: Cache Astropy data
+      uses: actions/cache@v4
+      with:
+        key: ${{ matrix.toxenv }}
+        path: ~/.astropy/cache
+    - name: Set up python ${{ matrix.python }} on ${{ matrix.os }}
+      uses: actions/setup-python@v5
+      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@v5
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+
+    - name: Upload test results to Codecov
+      if: contains(matrix.toxenv, '-cov')
+      uses: codecov/test-results-action@v1
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}

m4opt-0.1.0/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '38 10 * * 4'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v3
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3

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

@@ -0,0 +1,19 @@
+name: Publish
+
+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@8c0fde6f7e926df6ed7057255d29afa9c1ad5320  # v1.16.0
+    secrets:
+      pypi_token: ${{ secrets.pypi_token }}

m4opt-0.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-0.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: v5.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.9.6
+    hooks:
+      # Run the linter.
+      - id: ruff
+        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-0.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-0.1.0/CHANGES.rst

@@ -0,0 +1,8 @@
+*******
+Changes
+*******
+
+0.1.0 (2025-02-24)
+==================
+
+- First release.

m4opt-0.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-0.1.0/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.2
+Name: m4opt
+Version: 0.1.0
+Summary: Multi-Mission Multi-Messenger Observation Planning Toolkit
+Author-email: M4OPT Developers <leo.singer@ligo.org>
+License: 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
+Project-URL: Source Code, https://github.com/m4opt/m4opt
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+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: antiprism-python
+Requires-Dist: astropy>=7.0.0
+Requires-Dist: astropy-healpix
+Requires-Dist: cplex
+Requires-Dist: docplex
+Requires-Dist: dust-extinction
+Requires-Dist: dustmaps
+Requires-Dist: ligo.skymap>=2.2.0
+Requires-Dist: numpy>=2.1.0
+Requires-Dist: regions
+Requires-Dist: satellitetle
+Requires-Dist: scipy
+Requires-Dist: sgp4
+Requires-Dist: spiceypy
+Requires-Dist: sympy
+Requires-Dist: synphot
+Requires-Dist: typer
+Requires-Dist: typing_extensions; python_version < "3.12"
+Requires-Dist: xdg-base-dirs
+Provides-Extra: test
+Requires-Dist: astroplan; 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-typer; extra == "docs"
+
+Multi-Mission Multi-Messenger Observation Planning Toolkit
+----------------------------------------------------------
+
+.. 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:: docs/_static/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.
+
+
+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>`_.

m4opt-0.1.0/README.rst

@@ -0,0 +1,98 @@
+Multi-Mission Multi-Messenger Observation Planning Toolkit
+----------------------------------------------------------
+
+.. 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:: docs/_static/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.
+
+
+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>`_.