Command Line Interface# m4opt# m4opt Usage: m4opt [OPTIONS] COMMAND [ARGS]... ╭─ Options ────────────────────────────────────────────────────────────────────╮ │--versionPrint version and exit.│ │--install-completionInstall completion for the current shell.│ │--show-completionShow completion for the current shell, to copy│ │it or customize the installation. │ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────╯ ╭─ Commands ───────────────────────────────────────────────────────────────────╮ │animate Generate an animation for a GW sky map. │ │prime Download and cache all dependencies that m4opt may use at runtime.│ │scheduleGenerate an observing plan for a GW sky map. │ ╰──────────────────────────────────────────────────────────────────────────────╯ animate# animate Usage: m4opt animate [OPTIONS] SCHEDULE.ecsv MOVIE.gif Generate an animation for a GW sky map. ╭─ Arguments ──────────────────────────────────────────────────────────────────╮ │*scheduleSCHEDULE.ecsvInput filename for schedule[required]│ │*output MOVIE.gif Output filename for animation[required]│ ╰──────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ────────────────────────────────────────────────────────────────────╮ │--time-stepASTROPY QUANTITYTime step for evaluating field of │ │regard │ │[default: 1.0 h] │ │--durationASTROPY QUANTITYDuration of animation│ │[default: 5.0 s] │ │--stillSTILL.pdf Optional output file for still frame│ │--dpiFLOAT Output resolution │ │--inset-centerSKYCOORD Center of optional zoomed inset│ │--inset-radiusASTROPY QUANTITYRadius of optional zoomed inset│ │[default: 10.0 deg] │ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────╯ prime# prime Usage: m4opt prime [OPTIONS] Download and cache all dependencies that m4opt may use at runtime. Under normal operation, m4opt will download and cache various external data sources (for example, IERS Earth orientation data and Planck dust maps). If you need to run m4opt in an environment with no outbound Internet connectivity (for example, some computing clusters), you can run this command to download and cache the external data sources immediately. ╭─ Options ────────────────────────────────────────────────────────────────────╮ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────╯ schedule# schedule Usage: m4opt schedule [OPTIONS] INPUT.multiorder.fits SCHEDULE.ecsv Generate an observing plan for a GW sky map. The scheduler has three modes: 1. Fixed exposure time. Every field has the same exposure time given by the --exptime-min option. This mode is selected if you omit the --absmag-mean option. 2. Variable exposure time. Each field may have a different exposure time, adjusted for the posterior median distance along each line of sight. This mode is selected if you specify a value for the --absmag-mean option but also pass the --no-appmag-dist option. 3. Variable exposure time with an absolute magnitude distribution. Each field may have a different exposure time, adjusted to optimize the detection probability given the posterior distance distribution and a Gaussian distribution of absolute magnitudes. This mode is selected if you specify the --absmag-mean option (and, optionally, the --absmag-stdev option). ╭─ Arguments ──────────────────────────────────────────────────────────────────╮ │*skymap INPUT.multiorder.fitsSky map filename[required]│ │*scheduleSCHEDULE.ecsv Output filename for generated │ │schedule │ │[required] │ ╰──────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ────────────────────────────────────────────────────────────────────╮ │--mission[rubin|ultrasat|u[default: (uvex)]│ │vex|uvex_downlink│ │_orientation|ztf]│ │--skygridTEXT Name of sky grid to│ │use, if the mission│ │supports multiple │ │sky grids. │ │--delayASTROPY QUANTITY Delay from time of │ │event until the │ │start of │ │observations │ │[default: 0.0 d] │ │--deadlineASTROPY QUANTITY Maximum time from │ │event until the end│ │of observations │ │[default: 1.0 d] │ │--time-stepASTROPY QUANTITY Time step for │ │evaluating field of│ │regard │ │[default: 1.0 min] │ │--exptime-minASTROPY QUANTITY Minimum exposure │ │time for each │ │observation │ │[default: 900.0 s] │ │--exptime-maxASTROPY QUANTITY Maximum exposure │ │time for each │ │observation │ │[default: inf s] │ │--absmag-meanFLOAT Mean AB absolute │ │magnitude of source│ │[default: (disable │ │adaptive exposure │ │time)] │ │--absmag-stdevFLOAT Standard deviation │ │of AB absolute │ │magnitude of source│ │[default: (AB │ │absolute magnitude │ │is fixed at the │ │value provided by │ │--absmag-mean)] │ │--appmag-dist--no-appmag-distEnable point-wise │ │distribution of │ │apparent magnitude │ │[default: │ │appmag-dist] │ │--snrFLOAT Signal to noise │ │ratio for detection│ │[default: 5] │ │--bandpassTEXT Name of detector │ │bandpass │ │--visitsINTEGER RANGE Number of visits│ │[x>=1][default: 2] │ │--cadenceASTROPY QUANTITY Minimum time │ │separation between │ │visits │ │[default: 30.0 min]│ │--nsideINTEGER HEALPix resolution│ │[default: 512] │ │--helpShow this message │ │and exit. │ ╰──────────────────────────────────────────────────────────────────────────────╯ ╭─ Solver Options ─────────────────────────────────────────────────────────────╮ │--timelimitASTROPY QUANTITY Time limit for MILP │ │solver │ │[default: 1e+75 s] │ │--memoryASTROPY QUANTITY Maximum solver memory │ │usage before terminating │ │[default: inf Gibyte] │ │--jobs-jINTEGER RANGE [x>=0]Number of threads for │ │parallel processing, or 0│ │for all cores │ │[default: 0] │ │--cutoffFLOAT RANGE [0<=x<=1]Objective cutoff. Give up│ │if there are no feasible │ │solutions with objective │ │value greater than or │ │equal to this value │ │--write-progressPROGRESS.ecsv Save a time series of the│ │CPLEX objective value and│ │best bound to this file │ │--write-modelMODEL.{lp,mps,sav}[.gz]Export the MILP model in │ │LP, SAV, or MPS format. │ │Mainly useful for │ │troubleshooting purposes │ ╰──────────────────────────────────────────────────────────────────────────────╯