Welcome to AutoRA GUI’s documentation!

Contents

• API
  • Data model
    • AutoraBaseModel
      • AutoraBaseModel.model_config
      • AutoraBaseModel.uuid
    • CanvasLocation
      • CanvasLocation.model_config
      • CanvasLocation.x
      • CanvasLocation.y
    • Cardinality
      • Cardinality.maxOccurs
      • Cardinality.minOccurs
      • Cardinality.model_config
      • Cardinality.unique
    • Component
      • Component.canvasLocation
      • Component.model_config
    • Datatype
      • Datatype.ANY
      • Datatype.BOOLEAN
      • Datatype.CATEGORICAL
      • Datatype.DV
      • Datatype.INTEGER
      • Datatype.IV
      • Datatype.REAL
      • Datatype.STRING
    • DictVariableType
      • DictVariableType.model_config
      • DictVariableType.variables
    • EndComponent
      • EndComponent.model_config
    • Filter
      • Filter.altTarget
      • Filter.maxCounter
      • Filter.model_config
    • FilterComponent
      • FilterComponent.altTarget
      • FilterComponent.maxCounter
      • FilterComponent.model_config
    • Link
      • Link.model_config
      • Link.source
      • Link.target
    • ListVariableType
      • ListVariableType.model_config
      • ListVariableType.variable
    • ParameterSetting
      • ParameterSetting.model_config
      • ParameterSetting.value
    • PrimitiveVariableType
      • PrimitiveVariableType.cardinality
      • PrimitiveVariableType.datatype
      • PrimitiveVariableType.default
      • PrimitiveVariableType.model_config
      • PrimitiveVariableType.sympify
      • PrimitiveVariableType.validValues
    • Protocol
      • Protocol.description
      • Protocol.githubCommit
      • Protocol.github_io
      • Protocol.importPath
      • Protocol.inputDataType
      • Protocol.model_config
      • Protocol.name
      • Protocol.outputDataType
      • Protocol.parameters
      • Protocol.pipInstall
      • Protocol.protocolType
      • Protocol.pythonName
      • Protocol.runReturnsDV
    • ProtocolComponent
      • ProtocolComponent.model_config
      • ProtocolComponent.parameterSetting
      • ProtocolComponent.protocolUuid
    • ProtocolType
      • ProtocolType.EXPERIMENTALIST
      • ProtocolType.EXPERIMENT_RUNNER
      • ProtocolType.THEORIST
    • StartComponent
      • StartComponent.model_config
    • VariableType
      • VariableType.description
      • VariableType.model_config
      • VariableType.name
    • Workflow
      • Workflow.components
      • Workflow.dependentVariables
      • Workflow.description
      • Workflow.end
      • Workflow.filters
      • Workflow.independentVariables
      • Workflow.links
      • Workflow.model_config
      • Workflow.name
      • Workflow.start
    • generate_schemas()
  • Utilities
    • find_package_location()
    • find_repo_location()
  • React app server
    • CanvasLocation
      • CanvasLocation.model_config
      • CanvasLocation.x
      • CanvasLocation.y
    • ControlComponent
      • ControlComponent.canvasLocation
      • ControlComponent.model_config
      • ControlComponent.uuid
    • FilterComponent
      • FilterComponent.altTarget
      • FilterComponent.canvasLocation
      • FilterComponent.maxCounter
      • FilterComponent.model_config
      • FilterComponent.uuid
    • ParameterSetting
      • ParameterSetting.model_config
      • ParameterSetting.name
      • ParameterSetting.uuid
      • ParameterSetting.value
    • Workflow
      • Workflow.components
      • Workflow.description
      • Workflow.end
      • Workflow.filters
      • Workflow.links
      • Workflow.model_config
      • Workflow.name
      • Workflow.start
    • WorkflowComponent
      • WorkflowComponent.canvasLocation
      • WorkflowComponent.model_config
      • WorkflowComponent.parameterSetting
      • WorkflowComponent.protocolUuid
      • WorkflowComponent.uuid
    • WorkflowLink
      • WorkflowLink.model_config
      • WorkflowLink.source
      • WorkflowLink.target
    • get_components()
    • get_components_by_category()
    • get_schema()
    • lifespan()
    • load_components()
    • load_schema()
    • save_workflow()
    • validate_workflow()
  • React app build tooling
    • create_single_html()
    • main()
    • run_npm_build()
• Frontend (JavaScript) API

Frontend (JavaScript) API

The browser front-end (the React workflow editor) is documented separately, generated from its JSDoc comments: Frontend API reference.