modelon.impact package

Subpackages

• modelon.impact.client package
  • Subpackages
    • modelon.impact.client.entities package
      • Subpackages
        • modelon.impact.client.entities.interfaces package
      • Submodules
      • modelon.impact.client.entities.asserts module
        • assert_successful_operation()
        • assert_variable_in_result()
      • modelon.impact.client.entities.case module
        • Case
        • CaseAnalysis
        • CaseInput
        • CaseMeta
        • CaseRunInfo
      • modelon.impact.client.entities.content module
        • ContentType
        • ProjectContent
      • modelon.impact.client.entities.custom_artifact module
        • CustomArtifact
      • modelon.impact.client.entities.custom_function module
        • CustomFunction
        • ParameterDict
      • modelon.impact.client.entities.experiment module
        • Experiment
        • ExperimentMetaData
        • ExperimentResultPoint
        • ExperimentRunInfo
        • ExperimentSizeInfo
      • modelon.impact.client.entities.external_result module
        • ExternalResult
        • ExternalResultMetaData
      • modelon.impact.client.entities.file_uri module
        • CustomArtifactURI
        • FileURI
        • ModelicaResourceURI
        • URI
        • URISchema
        • get_resource_URI_from_str()
      • modelon.impact.client.entities.log module
        • Log
      • modelon.impact.client.entities.model module
        • Model
        • to_domain_parameter_value()
      • modelon.impact.client.entities.model_executable module
        • ModelDescription
        • ModelExecutable
        • ModelExecutableInput
        • ModelExecutableRunInfo
      • modelon.impact.client.entities.project module
        • GitRepoURL
        • Project
        • ProjectDefinition
        • ProjectDependency
        • ProjectType
        • StorageLocation
        • SvnRepoURL
        • VcsUri
      • modelon.impact.client.entities.result module
        • Result
      • modelon.impact.client.entities.status module
        • CaseStatus
        • ExperimentStatus
        • ModelExecutableStatus
      • modelon.impact.client.entities.workspace module
        • AccessSettings
        • AppMode
        • OwnerData
        • ProjectEntry
        • PublishedWorkspace
        • PublishedWorkspaceACL
        • PublishedWorkspaceDefinition
        • PublishedWorkspaceRequester
        • PublishedWorkspaceType
        • PublishedWorkspaceUploadStatus
        • ReceivedFrom
        • ReceivedFromWorkspace
        • Reference
        • ReleasedProjectReference
        • VcsReference
        • Workspace
        • WorkspaceDefinition
      • Module contents
    • modelon.impact.client.experiment_definition package
      • Subpackages
        • modelon.impact.client.experiment_definition.interfaces package
      • Submodules
      • modelon.impact.client.experiment_definition.asserts module
        • assert_valid_args()
        • assert_valid_case_modifiers()
        • assert_valid_extensions()
        • validate_initialize_from()
      • modelon.impact.client.experiment_definition.expansion module
        • FullFactorial
        • LatinHypercube
        • Sobol
      • modelon.impact.client.experiment_definition.extension module
        • SimpleExperimentExtension
      • modelon.impact.client.experiment_definition.fmu_based module
        • SimpleFMUExperimentDefinition
      • modelon.impact.client.experiment_definition.model_based module
        • SimpleModelicaExperimentDefinition
      • modelon.impact.client.experiment_definition.modifiers module
        • DataType
        • Enumeration
        • Modifier
        • ValueModifier
        • data_type_from_value()
        • ensure_as_modifier()
        • modifiers_to_dict()
      • modelon.impact.client.experiment_definition.operators module
        • Beta
        • Choices
        • Normal
        • Operator
        • Range
        • Uniform
        • get_operator_from_dict()
      • modelon.impact.client.experiment_definition.util module
        • case_to_identifier_dict()
        • custom_function_parameters_to_dict()
        • get_options()
      • Module contents
    • modelon.impact.client.operations package
      • Subpackages
        • modelon.impact.client.operations.workspace package
      • Submodules
      • modelon.impact.client.operations.base module
        • AsyncOperation
        • AsyncOperationStatus
        • BaseOperation
        • EntityFromOperation
        • ExecutionOperation
        • Status
      • modelon.impact.client.operations.case module
        • CaseOperation
      • modelon.impact.client.operations.case_result module
        • CaseResultImportOperation
      • modelon.impact.client.operations.content_import module
        • ContentImportOperation
      • modelon.impact.client.operations.custom_artifact module
        • CustomArtifactImportOperation
      • modelon.impact.client.operations.experiment module
        • ExperimentOperation
      • modelon.impact.client.operations.external_result_import module
        • ExternalResultImportOperation
      • modelon.impact.client.operations.fmu_import module
        • FMUImportOperation
      • modelon.impact.client.operations.model_executable module
        • CachedModelExecutableOperation
        • ModelExecutableOperation
      • modelon.impact.client.operations.project_import module
        • ProjectImportOperation
      • Module contents
    • modelon.impact.client.sal package
      • Submodules
      • modelon.impact.client.sal.context module
        • Context
      • modelon.impact.client.sal.custom_function module
        • CustomFunctionService
      • modelon.impact.client.sal.exceptions module
        • CommunicationError
        • ErrorBodyIsNotJSONError
        • ErrorJSONInvalidFormatError
        • HTTPError
        • InvalidContentTypeError
        • NoResponseFetchVersionError
        • SSLError
        • ServiceAccessError
        • UnauthorizedError
      • modelon.impact.client.sal.experiment module
        • ExperimentService
        • ResultFormat
      • modelon.impact.client.sal.exports module
        • ExportService
      • modelon.impact.client.sal.external_result module
        • ExternalResultService
      • modelon.impact.client.sal.http module
        • HTTPClient
      • modelon.impact.client.sal.imports module
        • ImportService
      • modelon.impact.client.sal.model_executable module
        • ModelExecutableService
      • modelon.impact.client.sal.project module
        • ProjectService
      • modelon.impact.client.sal.request module
        • Request
        • RequestCSV
        • RequestFileStream
        • RequestJSON
        • RequestMatStream
        • RequestOctetStream
        • RequestText
        • RequestXML
        • RequestZip
      • modelon.impact.client.sal.response module
        • CSVResponse
        • FileResponse
        • JSONResponse
        • MatStreamResponse
        • OctetStreamResponse
        • Response
        • ResponseError
        • TextResponse
        • XMLResponse
        • ZIPResponse
      • modelon.impact.client.sal.service module
        • Service
        • is_jupyterhub_url()
      • modelon.impact.client.sal.uri module
        • URI
      • modelon.impact.client.sal.users module
        • UsersService
      • modelon.impact.client.sal.workspace module
        • WorkspaceService
      • Module contents
  • Submodules
  • modelon.impact.client.client module
    • Client
      • Client.convert_workspace()
      • Client.create_workspace()
      • Client.get_case_by_reference()
      • Client.get_executions()
      • Client.get_experiment_by_reference()
      • Client.get_me()
      • Client.get_project()
      • Client.get_project_matchings()
      • Client.get_projects()
      • Client.get_published_workspaces_client()
      • Client.get_workspace()
      • Client.get_workspace_by_name()
      • Client.get_workspaces()
      • Client.import_project_from_zip()
      • Client.import_workspace_from_shared_definition()
      • Client.import_workspace_from_zip()
      • Client.upload_workspace()
    • Execution
      • Execution.from_dict()
      • Execution.id
      • Execution.kind
      • Execution.workspace_id
    • ExecutionKind
      • ExecutionKind.COMPILATION
      • ExecutionKind.EXPERIMENT
    • ProjectMatching
      • ProjectMatching.entry_id
      • ProjectMatching.get_selection()
      • ProjectMatching.make_selection_interactive()
      • ProjectMatching.projects
      • ProjectMatching.vcs_uri
    • ProjectMatchings
      • ProjectMatchings.entries
      • ProjectMatchings.make_selections_interactive()
    • Selection
      • Selection.entry_id
      • Selection.project
      • Selection.to_dict()
    • Tenant
      • Tenant.from_dict()
      • Tenant.group_name
      • Tenant.id
    • User
      • User.email
      • User.firstname
      • User.from_dict()
      • User.id
      • User.last_name
      • User.license
      • User.roles
      • User.tenant
      • User.username
  • modelon.impact.client.configuration module
    • Experimental
    • get_client_experimental()
    • get_client_interactive()
    • get_client_url()
  • modelon.impact.client.credential_manager module
    • CredentialManager
      • CredentialManager.get_key()
      • CredentialManager.get_key_from_env()
      • CredentialManager.get_key_from_file()
      • CredentialManager.get_key_from_prompt()
      • CredentialManager.write_key_to_file()
  • modelon.impact.client.exceptions module
    • AuthenticationError
    • Error
    • ExternalResultUploadError
    • FailedOrphanCleanup
    • IllegalCaseResultImport
    • IllegalContentImport
    • IllegalCustomArtifactImport
    • IllegalFMUImport
    • IllegalProjectImport
    • IllegalWorkspaceConversion
    • IllegalWorkspaceExport
    • IllegalWorkspaceImport
    • NoAssignedLicenseError
    • NoAssociatedPublishedWorkspaceError
    • NoSuchCustomArtifactError
    • OperationCompleteError
    • OperationFailureError
      • OperationFailureError.for_operation()
    • OperationNotCompleteError
      • OperationNotCompleteError.for_operation()
    • OperationTimeOutError
    • RemotePublishedWorkspaceLinkError
    • UnsupportedSemanticVersionError
  • modelon.impact.client.options module
    • BaseExecutionOptions
      • BaseExecutionOptions.with_values()
    • CompilerOptions
    • ProjectExecutionOptions
      • ProjectExecutionOptions.compiler_options
      • ProjectExecutionOptions.custom_function
      • ProjectExecutionOptions.runtime_options
      • ProjectExecutionOptions.simulation_options
      • ProjectExecutionOptions.solver_options
      • ProjectExecutionOptions.to_dict()
    • RuntimeOptions
    • SimulationOptions
      • SimulationOptions.with_result_filter()
    • SolverOptions
  • modelon.impact.client.published_workspace_client module
    • OrphanPublishedWorkspaceOwner
      • OrphanPublishedWorkspaceOwner.group_name
      • OrphanPublishedWorkspaceOwner.id
      • OrphanPublishedWorkspaceOwner.username
    • PublishedWorkspaceAccess
      • PublishedWorkspaceAccess.published_workspace
      • PublishedWorkspaceAccess.requested_id
      • PublishedWorkspaceAccess.requested_username
      • PublishedWorkspaceAccess.sharing_id
    • PublishedWorkspaceAccessKind
      • PublishedWorkspaceAccessKind.REQUESTED_BY_ME
      • PublishedWorkspaceAccessKind.REQUESTED_FROM_ME
      • PublishedWorkspaceAccessKind.SHARED_BY_ME
      • PublishedWorkspaceAccessKind.SHARED_WITH_ME
    • PublishedWorkspacesClient
      • PublishedWorkspacesClient.find()
      • PublishedWorkspacesClient.get_by_id()
  • Module contents

Module contents