Skip to content

Latest commit

 

History

History
75 lines (45 loc) · 1.81 KB

reference.rst

File metadata and controls

75 lines (45 loc) · 1.81 KB

Architecture and packages reference

is built in Python and includes an architecture designed for ease of use, flexibility, and extensibility. You can quickly get up and running and see the capabilities of by using one of the many included example Python scripts demonstrating the functionality of the packages.

is built in a modular fashion, as seen in the diagrams below. design includes multiple packages and APIs, providing both the flexibility to only include the necessary packages for your modeling needs and the extensibility by using the APIs for any needed customization.

Packages overview

/diagrams/packages_overview.puml

Packages and APIs

The following diagrams help illustrate the primary packages and associated APIs available for modeling and development with :

Core and job orchestration

/diagrams/core.puml

Local platform

/diagrams/local.puml

platform

/diagrams/comps.puml

platform

/diagrams/slurm.puml

Models reference

/diagrams/models.puml

API class specifications

/diagrams/apis.puml

/diagrams/apis-emod.puml

support with is provided with the emodpy package, which leverages plugin architecture.

API Documentation

api/idmtools_index api/idmtools_models_index api/idmtools_platform_comps_index api/idmtools_platform_local_index api/idmtools_platform_slurm_index api/idmtools_slurm_utils_index