Study Governor

The Study Governor is an automated data and state manager. This service keeps track of the status of all data samples (usually scan sessions) in a study and automates the process. This is the brain of the imaging infrastructure. It exposes a REST API and a web interface to monitor and manage the study process.

The Study Governor is licensed with the Apache 2.0 license.

You can find the source code in this repository

Study Governor documentation

• Introduction
• How To’s
  • StudyGovernor Deployment
    • Deployment using docker-compose
    • Deployment using kubernetes
    • Configuration values for kubernetes
    • Setting up a development environment for kubernetes
    • Setting up local development environment
  • StudyGovernor Configuration
• K8s Deployment
  • Configuring StudyGovernor deployment
  • Adding Study specific data
• Manual
  • Workflows
    • States
    • Transitions
    • Callbacks
    • Conditions
  • Permissions
  • Callbacks
    • command()
    • create_task()
    • create_taskgroup()
    • external_program()
    • fastr()
    • python_function()
    • send_mail()
    • sleep()
• REST API
• Code Reference
  • studygovernor Package
    • convert_to_bool()
    • create_app()
    • load_app_config()
    • load_config_from_env()
    • set_config_defaults()
    • set_default_config_value()
    • uia_username_mapper()
  • studygovernor.callbacks Module
    • clean_config()
    • clean_value()
    • dispatch_callback()
    • master_callback()
    • replace_mapping()
    • update_callback_execution()
  • studygovernor.exceptions Module
    • ConditionFunctionCallFailedError
    • ConditionFunctionReturnValueError
    • ConditionNotMetError
    • CouldNotFindResourceError
    • NoValidTransitionError
    • RESTResponseError
    • StateChangeError
    • StateNotFoundError
    • StudyGovernorClientError
    • StudyGovernorError
    • StudyGovernorHTTPError
    • StudyGovernorSSLError
    • UnknownConditionFunction
  • studygovernor.fields Module
    • MappingField
    • ObjectUrl
    • OptionalDatetime
    • SubUrl
  • studygovernor.util.filters Module
    • hyphenate_filter()
    • json_format_filter()
    • python_code_filter()
    • register_filters()
    • yaml_dump_filter()
  • studygovernor.util.helpers Module
    • create_workflow()
    • get_object_from_arg()
    • get_uri()
    • has_permission_all()
    • has_permission_any()
    • http_auth_optional()
    • initialize_workflow()
    • upgrade_workflow()
  • studygovernor.models Module
    • Action
    • Callback
    • CallbackExecution
    • CallbackExecutionResult
    • CallbackExecutionStatus
    • Cohort
    • Experiment
    • ExternalCohortUrls
    • ExternalExperimentLinks
    • ExternalSubjectLinks
    • ExternalSystem
    • ExternalSystemHistory
    • Role
    • Scan
    • Scantype
    • State
    • Subject
    • Transition
    • User
    • Variable
    • VariableType
    • Workflow
    • log_history()
• Changelog
  • 2024-07-02 - 8.1.0
    • Fixed
    • Added
    • Removed
  • 8.0.0 - 2023-12-15
    • New
    • Changed
  • 7.0.0 - 2023-03-10
    • New
    • Changed
  • 6.5.1 - 2022-03-09
    • Fixed
  • 6.5.0 - 2022-02-01
    • Added
    • Fixed
    • Changed
  • 6.4.0 - 2021-08-09
    • Added
    • Changed
    • Fixed
  • 6.3.0 - 2021-02-01
    • Added
    • Fixed
  • 6.2.1 - 2020-07-03
    • Changed
  • 6.2.0 - 2020-07-02
    • Added
    • Changed
    • Fixed
  • 6.1.0 - 2020-03-27
    • Added
  • 6.0.1 - 2020-01-30
    • Fixed
  • 6.0.0 - 2020-01-27
    • Added
    • Changed
    • Removed
  • 3.0.0 - 2018-10-24
    • Added
    • Changed
    • Fixed
  • 2.0.0 - 2017-06-26
    • Added

Indices and tables

• Index

• Module Index

• Search Page