In langfob/bdpg: Package For Building and Testing Biodiversity Problem Generators

Introduction

This document is a short summary of yaml file commands related to using the tzar program to run and capture output from other programs. More complete documentation for tzar can be found at Tzar distributed computing framework

Tzar links

• Tzar documentation on Confluence
  • https://tzar-framework.atlassian.net/wiki/display/TD/Tzar+documentation
  • Introduction - Tzar documentation on Confluence
    • https://tzar-framework.atlassian.net/wiki/display/TD/Introduction
  • Tzar project.yaml documentation
    • https://tzar-framework.atlassian.net/wiki/spaces/TD/pages/524338/The+project.yaml+file
• Lucy's Django interface
  • http://146.118.96.160/admin/
• Nectar login dashboard
  • https://dashboard.rc.nectar.org.au/
• Glass
  • http://glass.eres.rmit.edu.au/tzar_input/guppy/AlexFractalData/
• Atlassian OnDemand
  • https://tzar-framework.atlassian.net/login?dest-url=%2Fsecure%2FDashboard.jspa

Wildcards

Example

    full_output_dir_with_slash: $$output_path$$
    runset_name: $$runset$$
    run_id: $$run_id$$

Specific wildcards

Output path - $$output_path$$

    full_output_dir_with_slash: $$output_path$$

Runset name - $$runset$$

    runset_name: $$runset$$

Run ID - $$run_id$$

    run_id: $$run_id$$

Tzar project.yaml section headers

project_name: 

runner_class: 

libraries:

base_params:

scenarios:

repetitions:
    - name: 
      parameters:

repetitions:
    generators:
        - key: 
          generator_type: 
          start: 
          step_size: 
          count: 

Project name

project_name: 

Runner class

runner_class: 

Libraries

libraries:
    -  name: 
       repo_type: 
       url: 
       download_mode: 

Base parameters

base_params: 

Scenarios

scenarios: 

Repetitions

repetitions:
    - name: 
      parameters:

repetitions:
    generators:
        - key: 
          generator_type: 
          start: 
          step_size: 
          count: 

Generators

    generators:
        - key: 
          generator_type: 
          start: 
          step_size: 
          count: 

langfob/bdpg documentation built on Dec. 8, 2022, 5:33 a.m.