Skip to content

API Reference

Welcome to the AIBS Informatics Core API Reference. This section provides detailed documentation for all modules, classes, and functions in the library.

Module Overview

Core Modules

Module Description
Collections Collection classes including DeepChainMap, Tree, ValidatedStr, and enum base classes
Env Environment configuration and namespace management with EnvBase
Exceptions Custom exception classes

Executors

Module Description
Base Base executor class for creating task handlers
CLI Command-line interface utilities for executors

Models

Module Description
Base Base model classes (ModelProtocol, ModelBase, PydanticBaseModel)
Status Status-related models
Unique IDs Unique identifier models
Version Version handling models
Data Sync Data synchronization models
Email Address Email address models

Utils

Module Description
Decorators Utility decorators
File Operations File and directory utilities
Hashing Hashing functions
JSON JSON utilities
Logging Logging configuration and utilities
Modules Module handling utilities
Multiprocessing Multiprocessing utilities
OS Operations Operating system utilities
Time Time and date utilities
Units Unit conversion utilities
Version Version handling utilities
Dict Tools Dictionary manipulation tools
String Tools String manipulation tools