simdb package

SimDB.

SimDB is the IMAS simulation database management tool designed to track, manage and validate simulations and allow for these simulations to be sent for remote archiving and verification.

The tool comes in two parts:

• The command line interface (CLI) tool which users can run on the command line to add, edit, view and query stored simulations.

• The remote REST API which is run in a centralised location to allow the users simulations to be pushed for staging and checking.

Subpackages

• simdb.cli package
  • Subpackages
    • simdb.cli.commands package
      • check_meta_args()
      • Submodules
  • Submodules
    • simdb.cli.file_system module
      • FileSystem
    • simdb.cli.manifest module
      • AliasValidator
      • DataObject
      • DataObjectValidator
      • DescriptionValidator
      • DictValuesValidator
      • InputsValidator
      • InvalidAlias
      • InvalidManifest
      • ListValuesValidator
      • Manifest
      • ManifestValidator
      • MetaDataValidator
      • OutputsValidator
      • ResponsibleValidator
      • Sink
      • Source
      • VersionValidator
      • WorkflowValidator
      • get_loader()
      • ndarray_constructor()
    • simdb.cli.remote_api module
      • APIError
      • FailedConnection
      • RemoteAPI
      • RemoteError
      • check_return()
      • read_bytes()
      • try_request()
    • simdb.cli.simdb module
      • AliasCommandGroup
      • add_commands()
      • main()
      • recursive_help()
• simdb.config package
  • Config
    • Config.CONFIG_FILE_NAME
    • Config.NOTHING
    • Config.api_version
    • Config.config_directory
    • Config.debug
    • Config.default_remote
    • Config.delete_option()
    • Config.delete_section()
    • Config.get_option()
    • Config.get_section()
    • Config.get_string_option()
    • Config.list_options()
    • Config.load()
    • Config.save()
    • Config.sections()
    • Config.set_option()
    • Config.user_config_path
    • Config.verbose
  • ConfigError
  • Submodules
    • simdb.config.config module
      • Config
      • ConfigError
• simdb.database package
  • Database
    • Database.DBMS
      • Database.DBMS.MSSQL
      • Database.DBMS.POSTGRESQL
      • Database.DBMS.SQLITE
    • Database.add_watcher()
    • Database.close()
    • Database.delete_simulation()
    • Database.engine
    • Database.get_aliases()
    • Database.get_file()
    • Database.get_metadata()
    • Database.get_simulation()
    • Database.get_simulation_children()
    • Database.get_simulation_data()
    • Database.get_simulation_parents()
    • Database.insert_simulation()
    • Database.list_files()
    • Database.list_metadata_keys()
    • Database.list_metadata_values()
    • Database.list_simulation_data()
    • Database.list_simulations()
    • Database.list_watchers()
    • Database.query_meta()
    • Database.query_meta_data()
    • Database.remove()
    • Database.remove_watcher()
    • Database.reset()
  • DatabaseError
  • get_local_db()
  • Subpackages
    • simdb.database.models package
      • Base
      • File
      • MetaData
      • Simulation
      • Watcher
      • Submodules
  • Submodules
    • simdb.database.database module
      • Database
      • DatabaseError
      • Session
      • get_local_db()
• simdb.email package
  • Submodules
    • simdb.email.server module
      • EmailServer
• simdb.imas package
  • Submodules
    • simdb.imas.checksum module
      • Hash
      • checksum()
    • simdb.imas.metadata module
      • MetricException
      • ReadValues
      • extract_ids_path()
      • fetch_metric()
      • load_imas_metadata()
      • load_metadata()
      • walk_dict()
      • walk_imas()
    • simdb.imas.utils module
      • DBEntry
      • ImasError
      • check_time()
      • convert_uri()
      • extract_ids_occurrence()
      • get_path_for_legacy_uri()
      • imas_files()
      • imas_timestamp()
      • is_missing()
      • list_idss()
      • open_imas()
• simdb.remote package
  • APIConstants
    • APIConstants.LIMIT_HEADER
    • APIConstants.PAGE_HEADER
    • APIConstants.SORT_ASC_HEADER
    • APIConstants.SORT_BY_HEADER
  • Subpackages
    • simdb.remote.apis package
      • Subpackages
      • Submodules
    • simdb.remote.core package
      • Subpackages
      • Submodules
  • Submodules
    • simdb.remote.app module
    • simdb.remote.wsgi module
• simdb.uda package
  • Submodules
    • simdb.uda.checksum module
      • checksum()
• simdb.validation package
  • TestParameters
  • ValidationError
  • Validator
    • Validator.validate()
    • Validator.validation_schemas()
  • Subpackages
    • simdb.validation.file package
      • find_file_validator()
      • Submodules
  • Submodules
    • simdb.validation.validator module
      • CustomValidator
      • LoadError
      • TestParameters
      • ValidationError
      • Validator

Submodules

• simdb.checksum module
  • sha1_checksum()
• simdb.docstrings module
  • inherit_docstrings()
• simdb.json module
  • CustomDecoder
  • CustomEncoder
    • CustomEncoder.default()
• simdb.notifications module
  • Notification
    • Notification.ALL
    • Notification.OBSOLESCENCE
    • Notification.REVISION
    • Notification.VALIDATION
• simdb.query module
  • QueryType
    • QueryType.AGE
    • QueryType.AGT
    • QueryType.ALE
    • QueryType.ALT
    • QueryType.EQ
    • QueryType.EXIST
    • QueryType.GE
    • QueryType.GT
    • QueryType.IN
    • QueryType.LE
    • QueryType.LT
    • QueryType.NE
    • QueryType.NI
    • QueryType.NONE
  • parse_query_arg()
  • query_compare()
• simdb.uri module
  • Authority
    • Authority.auth
    • Authority.empty()
    • Authority.host
    • Authority.port
  • Query
    • Query.empty()
    • Query.get()
    • Query.remove()
    • Query.set()
  • URI
    • URI.authority
    • URI.fragment
    • URI.path
    • URI.query
    • URI.scheme
    • URI.uri
  • URIParserError