get_runs

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

Load metadata on opsim runs into a pandas.DataFrame.

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:

runspandas.DataFrame

run

The index of the DataFrame is the project-standard name for the run (str)

family

A list of run families to which this run belongs (list [str])

version

The simulation version

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])

filepath

The file path, relative to a base opsim output directory.

url

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

Notes

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