get_family_runs

rubin_sim.maf.run_comparison.get_family_runs(run_source=None)

Load a data frame that supplies run names for each run family

Parameters:

run_sourceNone or str

File name or URL for the json file from which to load the metadata. If it is set to None, the data is loaded from the URL specified by the archive.RUNS_SOURCE constant.

Returns:

familiespandas.DataFrame

families

The index is the run family. (str)

run

the project-standard name for the run (str)

OpsimGroup

The name for the group to which the runs belong (str)

OpsimComment

Short description of the run (str)

OpsimVersion

Opsim version name (str)

OpsimDate

Date for the version of opsim (TODO: ?)

brief

A list of descriptions for the run. Runs may have a different description for each family it belongs to, so it a list of the same length as the families column (list [str])

url

The URL from which the opsim output database for this run can be downloaded.

Notes

Because runs can be members of multiple families, more than one row may provide metadata on the same run.

The same content (in a different form) can be obtained using get_runs. get_runs is more convenient when indexing by run; get_family_runs when indexing by family.