Data sections

A campaign is a bounded data collection effort — defined by dates, geographic scope, and the instruments used — that belongs to a dataset. Every sampling log must reference a campaign.

The campaign record is also where the link between a dataset and its analytical provisions (instruments and labs) is established, via the provision_id__provision_name_array parameter.

Prerequisites

  • Manage dataset must be complete.
  • Utility records referenced by campaigns must be populated (from Load utility data): territory, spatial_reference, location_method, unit, provision.

Notebook cell

In load_ai4sh_dataset_meta.ipynb, the Manage campaigns cell runs:

process_file = 'import_data/dataset/manage_process/manage_campaign.json'

structured_process_D, scheme_params_D = Initiate_process(notebook_path, scheme_file, process_file)

if structured_process_D is not None:
    Run_process(structured_process_D, scheme_params_D)

Manage process file

Path: ./ai4sh/import_data/dataset/manage_process/manage_campaign.json

{
  "process": [
    {
      "root_process_id": "import_tabular_data",
      "process": "manage_campaign",
      "delete": false,
      "overwrite": false,
      "parameters": {
        "dataset_id__dataset_name": "lucas",
        "name": "lucas_eu_2009",
        "display_name": "LUCAS 2009",
        "begin_date": 20090501,
        "end_date": 20091031,
        "abstract": "LUCAS 2009 topsoil survey.",
        "laboratory": 1,
        "territory_id__territory_name": "eu",
        "site": "europe",
        "spatial_reference_id__spatial_reference_name": "geographic",
        "location_method_id__location_method_name": "gps",
        "location_error": 1000,
        "location_error_unit_id__unit_name": "m",
        "provision_id__provision_name_array": "metrohm-nirs-xds,lucas-wetlab-2009"
      }
    }
  ]
}

Parameters

Parameter Description
dataset_id__dataset_name FK lookup: parent dataset by alias
name Campaign identifier (lowercase)
display_name Display label
begin_date Start date as integer (YYYYMMDD)
end_date End date as integer (YYYYMMDD)
abstract Free-text description
laboratory Flag: 1 if laboratory analyses included, 0 otherwise
territory_id__territory_name FK lookup: geographic territory
site Free-text site description
spatial_reference_id__spatial_reference_name FK lookup: coordinate reference system
location_method_id__location_method_name FK lookup: geolocation method
location_error Positional accuracy value
location_error_unit_id__unit_name FK lookup: unit for location_error (e.g. m)
provision_id__provision_name_array Comma-separated list of provision aliases — links this campaign to all the instruments and labs used

The provision_id__provision_name_array field

This parameter links a campaign to one or more provisions defined in the utility catalogues. Multiple provisions are listed as a comma-separated string:

"provision_id__provision_name_array": "metrohm-nirs-xds,lucas-wetlab-2009"

The framework resolves each name to its provision_id and creates a record in the campaign–provision junction table. All provisions listed here must already exist in observation_utility.provision.

Next step

Proceed to Manage sampling log.

Updated: