Skip to content

File Format

Types

Nexus manages mainly two distinct types of files, parameters and properties:

  • parameters files, corresponding to the parameters submitted by the optimizer in SDLabs for the next iteration of the current campaign.
  • properties files, corresponding to the measurements of that iteration, in addition to the same content as the corresponding parameters file.

Please note that it is important to keep the same file name for a properties file as its corresponding parameters file, as well as the metadata inside the file (e.g. IDs) for your campaign to run smoothly!

A third type of files let you store other data if needed, but these are not processed by SDLabs.

Formats

The two main file formats that are currently supported by SDLabs are CSV and YAML.

Below is an example of such files for a workstation containing parameters 'param_a' and 'param_b', and measurements 'yield' and 'conductivity'.

.yaml example

Parameters file (job_submission_<###>.yaml) Properties file (job_submission_<###>.yaml) 


campaign_id: cpg_98c6319087544c72a0b809533a1effb4
id: rqt_8a4a3a22f931430087e1b586c6007242
iteration: 1
processes:
  param_a: 0.7
  param_b: 0.3
workstation_id: wst_bce0a23a7c2e145090f93cf71a80242f




campaign_id: cpg_98c6319087544c72a0b809533a1effb4
id: rqt_8a4a3a22f931430087e1b586c6007242
iteration: 1
processes:
  param_a: 0.7
  param_b: 0.3
properties:
  yield: 0.433
  selectivity: 0.543
workstation_id: wst_bce0a23a7c2e145090f93cf71a80242f
notes: Some comment on this experiment.

.csv example

Parameters file (job_submission_<###>.csv)

campaign_id id iteration param_a param_b workstation_id
cpg_98c6319087544c72a0b809533a1effb4 rqt_8a4a3a22f931430087e1b586c6007242 1 0.7 0.3 wst_bce0a23a7c2e145090f93cf71a80242f

Properties file (job_submission_<###>.csv)
campaign_id id iteration param_a param_b yield selectivity workstation_id notes
cpg_98c6319087544c72a0b809533a1effb4 rqt_8a4a3a22f931430087e1b586c6007242 1 0.7 0.3 0.433 0.543 wst_bce0a23a7c2e145090f93cf71a80242f Some comments on this experiments

Remarks

  • The notes in the properties files are optional (if you do not need to add notes, then do not add the field in the YAML file or the column header in the CSV file).
  • A parameters file and its corresponding properties file share the same content, except for the additional properties (new fields for YAML files, new columns for CSV files).
  • A properties file must have the same name as its corresponding parameters file.
  • Parameters names must match workstation parameters names, and properties names must match workstation measurements names.