Get CERN Open Data Analysis Environment
cern_opendata_get_analysis_envAssemble what is needed to analyse a record: its container images, CMSSW release and global tag; the condition-data, VM and validated-run records for its run periods; example software that declares it works with the record; and quoted sections of the guides the record links (the first two are fetched). Container images, software and guide code are licensed separately from the CC0 data. Use cern_opendata_list_files for the record's files.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| recid | Yes | Record id: up to 12 digits (6004), optionally after an experiment prefix (cms-93956); recid:6004 or a portal record URL also work. cern_opendata_search_records and cern_opendata_get_records return it. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Record type as the portal classifies it. | |
| error | No | Present when the call failed. Absent on success. | |
| recid | No | The record id. | |
| title | No | Record title. | |
| guides | No | Every portal guide linked in the usage section. | |
| notice | No | What could not be assembled and how to get it: an empty environment, linked records that could not be read, guides not fetched, not found or cut, a guide anchor no heading carries, or more linked records than shown. | |
| software | No | The record's own software environment (system_details). | |
| experiment | No | Experiments the record belongs to. | |
| run_period | No | Run periods the record covers, such as Run2012B. | |
| other_links | No | The other usage links (getting-started pages and the like). | |
| license_note | No | How the environment is licensed. | |
| example_software | No | Software records that declare they work with this record. | |
| environment_records | No | Condition, VM and validation records for the run periods, and others linking here. | |
| separately_licensed | No | Always true: images, software and guide code are licensed apart from the CC0 data. |