ogdc_runner package

ogdc-runner

Defines Open Geospatial Data Cloud (OGDC) recipe API(s) and submits recipes to OGDC for execution.

Subpackages

• ogdc_runner.dataone package
  • resolve_dataone_input()
  • Submodules
    • ogdc_runner.dataone.resolver module
      • DataONEResolver
      • resolve_dataone_input()
• ogdc_runner.models package
  • ExecutionFunction
    • ExecutionFunction.name
    • ExecutionFunction.command
    • ExecutionFunction.function
    • ExecutionFunction.command
    • ExecutionFunction.function
    • ExecutionFunction.model_config
    • ExecutionFunction.model_post_init()
    • ExecutionFunction.name
  • FilePartition
    • FilePartition.partition_id
    • FilePartition.files
    • FilePartition.execution_function
    • FilePartition.metadata
    • FilePartition.execution_function
    • FilePartition.files
    • FilePartition.metadata
    • FilePartition.model_config
    • FilePartition.partition_id
  • OgdcBaseModel
    • OgdcBaseModel.model_config
  • ParallelConfig
    • ParallelConfig.enabled
    • ParallelConfig.partition_strategy
    • ParallelConfig.partition_size
    • ParallelConfig.max_parallelism
    • ParallelConfig.enabled
    • ParallelConfig.max_parallelism
    • ParallelConfig.model_config
    • ParallelConfig.must_be_positive()
    • ParallelConfig.partition_size
    • ParallelConfig.partition_strategy
  • RecipeConfig
    • RecipeConfig.id
    • RecipeConfig.model_config
    • RecipeConfig.recipe_directory
  • RecipeImage
    • RecipeImage.full_image_path
    • RecipeImage.image
    • RecipeImage.model_config
    • RecipeImage.tag
  • RecipeMeta
    • RecipeMeta.input
    • RecipeMeta.model_config
    • RecipeMeta.name
    • RecipeMeta.output
    • RecipeMeta.workflow
  • Submodules
    • ogdc_runner.models.base module
      • OgdcBaseModel
    • ogdc_runner.models.parallel_config module
      • ExecutionFunction
      • FilePartition
    • ogdc_runner.models.recipe_config module
      • DataOneInput
      • DataOneRecipeOutput
      • InputParam
      • ParallelConfig
      • PvcRecipeOutput
      • RecipeConfig
      • RecipeImage
      • RecipeInput
      • RecipeMeta
      • RecipeOutput
      • ShellWorkflow
      • TemporaryRecipeOutput
      • UrlInput
      • VizWorkflow
      • Workflow
• ogdc_runner.scripts package
• ogdc_runner.service package
  • Submodules
    • ogdc_runner.service.auth module
      • TokenResponse
      • create_access_token()
      • get_user_by_auth_token()
      • token()
    • ogdc_runner.service.auth_routes module
      • CreateUserResponse
      • OutputResponse
      • StatusResponse
      • SubmitRecipeRequest
      • SubmitRecipeResponse
      • create_user_route()
      • get_current_user()
      • get_output()
      • status()
      • submit()
    • ogdc_runner.service.db module
      • close_db()
      • get_engine()
      • init_db()
    • ogdc_runner.service.main module
      • VersionResponse
      • lifespan()
      • version()
    • ogdc_runner.service.user module
      • User
      • create_admin_user()
      • create_user()
      • get_user()
      • get_user_with_password()
      • hash_password()
      • verify_password()
• ogdc_runner.workflow package
  • Submodules
    • ogdc_runner.workflow.shell module
      • ShellParallelExecutionOrchestrator
      • make_and_submit_shell_workflow()
      • make_cmd_template()
    • ogdc_runner.workflow.viz_workflow module
      • create_3dtile_parallel()
      • create_composite_z_parallel()
      • create_web_tile_parallel()
      • discover_all_geotiffs()
      • discover_parent_tiles()
      • discover_staged_tiles()
      • make_and_submit_viz_workflow()
      • rasterize_max_z_parallel()
      • run_viz_serial()
      • stage_file_parallel()

Submodules

• ogdc_runner.api module
  • submit_ogdc_recipe()
• ogdc_runner.argo module
  • ArgoConfig
    • ArgoConfig.full_image_path
  • ArgoManager
    • ArgoManager.config
    • ArgoManager.update_image()
    • ArgoManager.workflow_service
  • OgdcWorkflow()
  • get_workflow_status()
  • make_generate_name()
  • submit_workflow()
  • wait_for_workflow_completion()
• ogdc_runner.constants module
• ogdc_runner.exceptions module
  • OgdcDataAlreadyPublished
  • OgdcDataOneError
  • OgdcInvalidRecipeConfig
  • OgdcInvalidRecipeDir
  • OgdcMissingEnvvar
  • OgdcOutputDataRetrievalError
  • OgdcRunnerException
  • OgdcServiceApiError
  • OgdcUserAlreadyExists
  • OgdcWorkflowExecutionError
• ogdc_runner.inputs module
  • make_fetch_input_template()
• ogdc_runner.parallel module
  • ParallelExecutionOrchestrator
    • ParallelExecutionOrchestrator.create_execution_template()
    • ParallelExecutionOrchestrator.create_parallel_tasks()
• ogdc_runner.partitioning module
  • create_partitions()
• ogdc_runner.publish module
  • check_for_existing_published_data()
  • check_for_existing_pvc_published_data()
  • data_already_published()
  • get_temporary_output_data_url()
  • make_publish_template()
  • remove_existing_published_data()
• ogdc_runner.recipe module
  • clone_recipes_repo()
  • find_recipe_dirs()
  • get_recipe_config()
  • stage_ogdc_recipe()
  • validate_all_recipes_in_repo()