Changes#
4.0.0 (2026-10-09)#
The
uvex_downlink_orientationmethod now requires anobserver_locationargument.
3.1.0 (2026-10-02)#
Fix a crash when scheduling a field that is observable in more than one window, as a ground based telescope sees whenever a field rises on several nights.
Update UVEX detector model from response files version 20260924_v0.1e from https://www.uvex.caltech.edu/page/uvex-etc.
3.0.0 (2026-09-20)#
Allow
--bandpassto be repeated so that successive visits cycle through several bandpasses. Every field is visited for the kth time before any field is visited for the k+1th, so a schedule exchanges the filter once per block boundary however many fields are observed.Add
Mission.filter_exchange_timeand set it to 110 s for ZTF.Allow
--exptime-minto be repeated so that each bandpass has its own exposure time, given in the same order as--bandpass; a single value applies to every bandpass as before. This applies to a fixed exposure time mode and is not yet supported with adaptive exposure time mode.Calculate the zodiacal light background in the mean ecliptic frame rather than the true ecliptic frame. This results in much faster ETC calculations at the expense of positional accuracy degrading to a fraction of an arcminute due to neglecting nutation.
2.15.0 (2026-09-14)#
Update CPLEX to version 22.2.0. Academic users who are upgrading will need to follow the instructions for downloading and installing CPLEX.
Add NominalRollConstraint, necessary for space-based spectroscopy with requirements on the position angle of a slit.
Progress information is now shown in Jupyter notebooks.
Add
m4opt.utils.console.quiet, a context manager to suppress progress messages inside awith:block.
2.14.0 (2026-09-11)#
Fix the interpolation of dust extinction. The count rate was sampled on a grid spaced linearly out to the most reddened pixel of the whole dust map, E(B-V) of 165, so that its first step landed at 0.32 and 82% of the sky fell inside it. The grid is now spaced in asinh and the logarithm of the count rate is interpolated, which extinction makes nearly straight, reducing the error from a few percent to about one part in a billion.
Add a
field_idcolumn to schedules, naming the field that each observation points at. For a mission that numbers its own fields the value is that number: ZTF’s sky grid is now indexed by its field identifiers, which run from 1 to 1897 across 1778 fields, with the numbers it does not use masked out. A slew points at no field, so its identifier is masked.Speed up evaluation of composite, logical “and” or logical “or”, constraints using short-circuit evaluation.
Add
ZodiacalBackgroundConstraint, a field of regard constraint that places a maximum value on the modeled surface brightness due to zodiacal light.
2.13.0 (2026-09-08)#
Fix a crash in variable exposure time mode for ground-based missions, where the observer location was passed as an array over all observing times rather than at the single time for which the exposure time is evaluated.
Fix
TypeErrorwhen a scalar appears on the left of an arithmetic operator applied to an array of decision variables, as in5 - x.Add
--max-fieldsto control how many of the most probable fields the scheduler considers, which was fixed at 50. The cap bounds the size of the MILP problem, which grows roughly quadratically with it, so raising it trades solving time for the chance to cover more of a large localization.Fix the ZTF sky grid, whose right ascensions were truncated by a fixed-width table reader so that all 1778 fields fell within 10 degrees of R.A. 0. ZTF schedules were empty as a result.
Add
--event-time, the time that--delayand--deadlineare measured from. It defaults to theDATE-OBSfield of the sky map as before, so a sky map written without one can now be scheduled, and a sky map missing it reports what to do rather than aKeyError. Schedules record the time they were measured from, andm4opt animatereads it from there rather than from the sky map.Use ULTRASAT’s tabulated throughput curve rather than a Gaussian approximation, which had a red leak some four orders of magnitude too large and nearly doubled the predicted zodiacal background.
Add
EarthshineBackground, a model of sunlight reflected off the Earth, scaled by the angular distance from the Earth’s limb and by the solar illumination of that part of the limb, and include it in the ULTRASAT stray light budget.Fix the ULTRASAT readout noise, which was set to the noise budget’s variance (6 e-/pix) rather than its RMS.
Add
intersect1d, an accelerated version ofnumpy.intersect1d.
2.12.0 (2026-08-28)#
Add
EclipticLatitudeConstraint.Add
AntiSolarSeparationConstraintto keep targets away from the anti-solar point, where the nominal spacecraft roll angle is undefined.Fix
LogicalNotConstraint, which ignored its operand and always evaluated to a scalarTrue.Fix
footprintandfootprint_healpixfor empty compoundRegions.Add
m4opt.utils.functional.applymethod.Add the function
count_intersect1d_combinationsto calculate the overlap of pairwise combinations of arrays, parallelized with OpenMP.This operation is needed to calculate per-pixel cadence distributions from HEALPix observation footprints. The specialized parallel version is necessary because
count_intersect1dcannot be effectively parallelized using Python techniques likemultiprocessing.
2.11.0 (2026-08-18)#
Speed up
solve_tspby adding extra cuts.Update the UVEX chip gaps.
2.10.0 (2026-08-13)#
Speed up
count_intersect1dby 4-5x.
2.9.1 (2026-08-09)#
Fix an issue with publishing abi3 wheels.
2.9.0 (2026-08-09)#
Add
count_intersect1dutility function for calculating cadence distributions accounting for field overlaps.
2.8.1 (2026-07-31)#
Adjust UVEX sky grid for new FOV model. The old grid contained 5412 fields while the new grid contains 4962 fields.
2.8.0 (2026-07-31)#
Add chip gaps for UVEX.
Add Cerenkov background for ULTRASAT.
m4opt.observer.EarthFixedObserverLocationis no longer a subclass ofastropy.coordinates.EarthLocation.Implement a helioecliptic longitude constraint.
2.7.0 (2026-06-29)#
Raise a RuntimeError if the SGP4 package was installed without its well-tested binary implementation.
Add support for jerk-limited slews.
Fix some corner cases in the scheduler when no fields are observable.
2.6.0 (2026-04-05)#
Add support for partitioning graphs with node and edge weights.
Add function to convert circle sky regions to polygons.
Add function to calculate approximate orientation of UVEX for a ground pass.
2.5.0 (2026-03-20)#
Add support for pointlike FOVs and FOVs that are nonconvex polygons.
The function
m4opt.fov.footprint_healpixnow has a default value for thetarget_coordargument.
2.4.0 (2026-03-06)#
Add exposure time models for Vera C. Rubin Observatory and Zwicky Transient Facility.
Update installation instructions for users of academic editions of CPLEX.
Drop support for Python 3.12.
2.3.1 (2026-01-23)#
Fix an issue where MILP optimization could terminate early before CPLEX had found a best bound. This was prone to happen after MIP restarts.
2.3.0 (2026-01-22)#
When available memory is limited by the
--memoryoption, spool CPLEX’s node file to disk.If the solution is aborted because the best bound falls below the objective lower cutoff, then record the solution status as
aborted, lower cutoff reached.
2.2.1 (2026-01-16)#
Fix crash for sky maps with invalid pixels when using a fixed absolute magnitude.
2.2.0 (2026-01-15)#
Add support to the scheduler for pointwise distance distributions but fixed absolute magnitude.
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.constraintsproperty no longer accepts a list of constraints. To combine multiple constraints, use boolean operators.The
Mission.detectorproperty 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.