idmtools-platform-container 0.0.0.dev0__tar.gz → 0.0.2__tar.gz

idmtools_platform_container-0.0.2/.bumpversion.cfg

@@ -0,0 +1,28 @@
+[bumpversion]
+current_version = 3.0.0+nightly
+commit = False
+tag = False
+parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(?P<release>\+\w+)?(\.(?P<build>\d+))?
+serialize = 
+	{major}.{minor}.{patch}{release}.{build}
+	{major}.{minor}.{patch}{release}
+	{major}.{minor}.{patch}
+
+[bumpversion:part:release]
+optional_value = prod
+first_value = prod
+values = 
+	prod
+	+nightly
+
+[bumpversion:file:./idmtools_platform_container/__init__.py]
+search = __version__ = "{current_version}"
+replace = __version__ = "{new_version}"
+serialize = {major}.{minor}.{patch}{release}
+	{major}.{minor}.{patch}
+
+[bumpversion:file:./pyproject.toml]
+search = version = "{current_version}"
+replace = version = "{new_version}"
+serialize = {major}.{minor}.{patch}{release}
+	{major}.{minor}.{patch}

idmtools_platform_container-0.0.2/LICENSE.TXT

@@ -0,0 +1,3 @@
+idmtools is licensed under the Creative Commons Attribution-Noncommercial-ShareAlike 4.0 License.
+
+To view a copy of this license, visit https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode

idmtools_platform_container-0.0.2/MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md
+include LICENSE.TXT

idmtools_platform_container-0.0.2/Makefile

@@ -0,0 +1,12 @@
+PACKAGE_NAME=idmtools_platform_container
+include $(abspath ../dev_scripts/package_general.mk)
+
+help: 
+	help-from-makefile -f ../dev_scripts/package_general.mk -f ./Makefile
+
+# Release related rules
+container-image: ## Build container Docker image
+	$(MAKE) -C docker_image docker
+
+container-image-release: ## Push image to staging
+	$(MAKE) -C docker_image  docker-release-staging

idmtools_platform_container-0.0.2/PKG-INFO

@@ -0,0 +1,212 @@
+Metadata-Version: 2.4
+Name: idmtools_platform_container
+Version: 0.0.2
+Summary: Container platform for IDM-Tools
+Author-email: Zhaowei Du <zdu@idmod.org>, Sharon Chen <shchen@idmod.org>, Clinton Collins <ccollins@idmod.org>, Benoit Raybaud <braybaud@idmod.org>, Clark Kirkman IV <ckirkman@idmod.org>, Ye Chen <yechen@idmod.org>, Mary Fisher <mafisher@idmod.org>, Mandy Izzo <mizzo@idmod.org>, Jen Schripsema <jschripsema@idmod.org>, Ross Carter <rcarter@idmod.org>
+Project-URL: Homepage, https://github.com/InstituteforDiseaseModeling/idmtools
+Keywords: modeling,IDM
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.TXT
+Requires-Dist: idmtools_platform_general<1.0.0,>=0.0.0
+Requires-Dist: docker>5.0
+Requires-Dist: rich
+Provides-Extra: test
+Requires-Dist: idmtools[test]; extra == "test"
+Requires-Dist: idmtools_test; extra == "test"
+Requires-Dist: idmtools_models; extra == "test"
+Provides-Extra: packaging
+Requires-Dist: flake8; extra == "packaging"
+Requires-Dist: coverage; extra == "packaging"
+Requires-Dist: bump2version; extra == "packaging"
+Requires-Dist: twine; extra == "packaging"
+Requires-Dist: natsort; extra == "packaging"
+Dynamic: license-file
+
+![Staging: idmtools-platform-container](https://github.com/InstituteforDiseaseModeling/idmtools/workflows/Staging:%20idmtools-platform-container/badge.svg?branch=dev)
+
+# Idmtools platform container
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**
+
+- [Introduction](#introduction)
+  - [Pre-requisites](#pre-requisites)
+  - [Installation](#installation)
+  - [Examples for container platform](#examples-for-container-platform)
+    - [Initialize platform](#initialize-platform)
+    - [Container Examples](#container-examples)
+    - [Check result with CLI commands](#check-result-with-cli-commands)
+    - [Check result files](#check-result-files)
+    - [Folder structure](#folder-structure)
+  - [Basic CLI commands](#basic-cli-commands)
+    - [List running jobs](#list-running-jobs)
+    - [Check status](#check-status)
+    - [Cancel job](#cancel-job)
+    - [View Experiments history](#view-experiments-history)
+  - [Note](#note)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+# Introduction
+
+**ContainerPlatform** is a platform designed to facilitate the execution of experiments and simulations within Docker containers. It provides a robust environment with all necessary tools and dependencies installed, allowing for seamless integration and execution of computational tasks.
+
+## Pre-requisites
+- Python 3.8/3.9/3.10/3.11/3.12 x64-bit
+- OS: 
+  - Windows 10 Pro or Enterprise
+  - Linux
+  - macOS (10.15 Catalina or later) 
+- Docker or Docker Desktop(required for the container platform)
+  On Windows, please use Docker Desktop 4.0.0 or later
+- **Mac user**: Only support Intel based **x86_64** architecture if you want to run emodpy related disease models on **Docker** container platform. Apple based ARM architecture currently is not supported. 
+
+## Installation
+
+- **Install python**
+
+   Ensure you have Python 3.8+ installed on your system.
+
+- Create and activate a virtual environment:
+    ```
+    python -m venv venv
+    source venv/bin/activate  # On macOS/Linux
+    venv\Scripts\activate     # On Windows
+    ```
+
+- Install all **container** platform related packages
+    ```bash
+    pip install idmtools[container] --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple
+    ```
+- Optional: Install all **idmtools** packages
+    ```bash
+    pip install idmtools[full] --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple
+    ```
+- To **override** existing idmtools container related packages after installing emodpy, run this command
+    ```bash
+    pip install idmtools[container] --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple --force-reinstall --no-cache-dir --upgrade
+    ``` 
+  **Mac user**: You map need to escape the square brackets with a backslash like `\[container\]` or `\[full\]` in above command.
+
+- Extra steps for Windows user:
+  - Enable **Developer Mode** on Windows
+
+    If you are running the script on Windows, you need to enable Developer Mode. To enable Developer Mode, go to Settings -> Update & Security -> For developers and select Developer Mode on, or refer to this [guide](https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development).
+
+  - Enable **long file path** for Windows
+  
+    Due to the file/folder structure design outlined in the section below, if running the script on Windows, be aware of the file path length limitation (less than 255 characters).
+  
+    To allow longer file paths, you can enable Long Path Support in the Windows Group Policy Editor.
+  Refer to this [guide](https://www.autodesk.com/support/technical/article/caas/sfdcarticles/sfdcarticles/The-Windows-10-default-path-length-limitation-MAX-PATH-is-256-characters.html) for detailed instructions.
+
+## Examples for container platform
+
+### Initialize platform
+- This is the example using Container Platform
+    ```python 
+    from idmtools.core.platform_factory import Platform
+    platform = Platform('CONTAINER', job_directory='<user job directory>')
+    ```
+- To trigger MPI, use ntasks >=2:
+    ```python
+    from idmtools.core.platform_factory import Platform
+    platform = Platform('CONTAINER', job_directory='<user job directory>', ntasks=2)
+    ```
+- More options for container platform initialization:
+    refer to [ContainerPlatform attributes](hhttps://docs.idmod.org/projects/idmtools/en/latest/platforms/container/index.html#containerplatform-attributes)
+
+### Container Examples
+  - idmtools examples: https://github.com/InstituteforDiseaseModeling/idmtools/tree/main/examples/platform_container
+  - emodpy-malaria examples: https://github.com/EMOD-Hub/emodpy-malaria/tree/main/examples-container
+
+
+### Check result with CLI commands
+  ```bash
+  idmtools container status <experiment id>
+  ```
+### Check result files
+    - on host: `<job_directory>/<suite_path>/<experiment_path>/<simulation_path>/`
+    - in container: `/home/container-data/<suite_path>/<experiment_path>/<simulation_path>/`
+
+
+### Folder structure
+By default, `idmtools` now generates simulations with the following structure:
+`job_directory/s_<suite_name>_<suite_uuid>/e_<experiment_name>_<experiment_uuid>/simulation_uuid`
+- `job_directory` — The base directory that contains all suite, experiment, and simulation folders.
+- `s_<suite_name>_<suite_uuid>` — The suite directory, where the suite name (truncated to a maximum of 30 characters) is prefixed with s_, followed by its unique suite UUID.
+- `e_<experiment_name>_<experiment_uuid>` — The experiment directory, where the experiment name (also truncated to 30 characters) is prefixed with e_, followed by its unique experiment UUID.
+- `simulation_uuid` — The simulation folder identified only by its UUID.
+
+Suite is optional. If the user does not specify a suite, the folder will be:
+`job_directory/e_<experiment_name>_<experiment_uuid>/simulation_uuid`
+
+Examples:
+
+If you create a suite named: `my_very_long_suite_name_for_malaria_experiment`
+
+and an experiment named: `test_experiment_with_calibration_phase`
+`idmtools` will automatically truncate both names to a maximum of 30 characters and apply the prefixes s_ for suites and e_ for experiments, resulting in a path like:
+```
+job_directory/
+└── s_my_very_long_suite_name_for_m_12345678-9abc-def0-1234-56789abcdef0/
+    └── e_test_experiment_with_calibrati_abcd1234-5678-90ef-abcd-1234567890ef/
+        └── 7c9e6679-7425-40de-944b-e07fc1f90ae7/
+```
+
+Or for no suite case:
+```
+job_directory/
+└── e_test_experiment_with_calibrati_abcd1234-5678-90ef-abcd-1234567890ef/
+    └── 7c9e6679-7425-40de-944b-e07fc1f90ae7/
+```
+
+Users can customize this structure through the idmtools.ini configuration file:
+- `name_directory = False` — Excludes the suite and experiment names (and their prefixes) from the simulation path.
+- `sim_name_directory = True` — Includes the simulation name in the simulation folder path when name_directory = True.
+
+## Basic CLI commands
+
+**ContainerPlatform** provides several CLI commands to manage and monitor experiments and simulations. Below are some basic commands:
+
+### List running jobs
+
+To list running experiment or simulation jobs:
+  ```bash
+  idmtools container jobs [<container-id>] [-l <limit>] [-n <next>]
+  ```
+
+### Check status
+
+To check the status of an experiment or simulation:
+```bash
+idmtools container status <item-id> [-c <container_id>] [-l <limit>] [--verbose/--no-verbose]
+```
+
+### Cancel job
+
+To cancel an experiment or simulation job:
+```bash
+idmtools container cancel <item-id> [-c <container_id>]
+```
+
+### View Experiments history
+
+To view experiments history:
+```bash
+idmtools container history [<container-id>] [-l <limit>] [-n <next>]
+```
+
+
+## Note
+
+- **WorkItem** is not supported on the Container Platform as it is not needed in most cases since the code already runs on user's local computer.
+- **AssetCollection** creation or referencing to an existing AssetCollection are not supported on the Container Platform with current release. If you've used the COMPS Platform, you may have scripts using these objects. You would need to update these scripts without using these objects in order to run them on the Container Platform.
+- Run with **Singularity** is not needed with Container Platform. If you take existing COMPS example and try to run it with Container Platform, you may need to remove the code that setups the singularity image.

idmtools_platform_container-0.0.2/README.md

@@ -0,0 +1,182 @@
+![Staging: idmtools-platform-container](https://github.com/InstituteforDiseaseModeling/idmtools/workflows/Staging:%20idmtools-platform-container/badge.svg?branch=dev)
+
+# Idmtools platform container
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**
+
+- [Introduction](#introduction)
+  - [Pre-requisites](#pre-requisites)
+  - [Installation](#installation)
+  - [Examples for container platform](#examples-for-container-platform)
+    - [Initialize platform](#initialize-platform)
+    - [Container Examples](#container-examples)
+    - [Check result with CLI commands](#check-result-with-cli-commands)
+    - [Check result files](#check-result-files)
+    - [Folder structure](#folder-structure)
+  - [Basic CLI commands](#basic-cli-commands)
+    - [List running jobs](#list-running-jobs)
+    - [Check status](#check-status)
+    - [Cancel job](#cancel-job)
+    - [View Experiments history](#view-experiments-history)
+  - [Note](#note)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+# Introduction
+
+**ContainerPlatform** is a platform designed to facilitate the execution of experiments and simulations within Docker containers. It provides a robust environment with all necessary tools and dependencies installed, allowing for seamless integration and execution of computational tasks.
+
+## Pre-requisites
+- Python 3.8/3.9/3.10/3.11/3.12 x64-bit
+- OS: 
+  - Windows 10 Pro or Enterprise
+  - Linux
+  - macOS (10.15 Catalina or later) 
+- Docker or Docker Desktop(required for the container platform)
+  On Windows, please use Docker Desktop 4.0.0 or later
+- **Mac user**: Only support Intel based **x86_64** architecture if you want to run emodpy related disease models on **Docker** container platform. Apple based ARM architecture currently is not supported. 
+
+## Installation
+
+- **Install python**
+
+   Ensure you have Python 3.8+ installed on your system.
+
+- Create and activate a virtual environment:
+    ```
+    python -m venv venv
+    source venv/bin/activate  # On macOS/Linux
+    venv\Scripts\activate     # On Windows
+    ```
+
+- Install all **container** platform related packages
+    ```bash
+    pip install idmtools[container] --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple
+    ```
+- Optional: Install all **idmtools** packages
+    ```bash
+    pip install idmtools[full] --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple
+    ```
+- To **override** existing idmtools container related packages after installing emodpy, run this command
+    ```bash
+    pip install idmtools[container] --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple --force-reinstall --no-cache-dir --upgrade
+    ``` 
+  **Mac user**: You map need to escape the square brackets with a backslash like `\[container\]` or `\[full\]` in above command.
+
+- Extra steps for Windows user:
+  - Enable **Developer Mode** on Windows
+
+    If you are running the script on Windows, you need to enable Developer Mode. To enable Developer Mode, go to Settings -> Update & Security -> For developers and select Developer Mode on, or refer to this [guide](https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development).
+
+  - Enable **long file path** for Windows
+  
+    Due to the file/folder structure design outlined in the section below, if running the script on Windows, be aware of the file path length limitation (less than 255 characters).
+  
+    To allow longer file paths, you can enable Long Path Support in the Windows Group Policy Editor.
+  Refer to this [guide](https://www.autodesk.com/support/technical/article/caas/sfdcarticles/sfdcarticles/The-Windows-10-default-path-length-limitation-MAX-PATH-is-256-characters.html) for detailed instructions.
+
+## Examples for container platform
+
+### Initialize platform
+- This is the example using Container Platform
+    ```python 
+    from idmtools.core.platform_factory import Platform
+    platform = Platform('CONTAINER', job_directory='<user job directory>')
+    ```
+- To trigger MPI, use ntasks >=2:
+    ```python
+    from idmtools.core.platform_factory import Platform
+    platform = Platform('CONTAINER', job_directory='<user job directory>', ntasks=2)
+    ```
+- More options for container platform initialization:
+    refer to [ContainerPlatform attributes](hhttps://docs.idmod.org/projects/idmtools/en/latest/platforms/container/index.html#containerplatform-attributes)
+
+### Container Examples
+  - idmtools examples: https://github.com/InstituteforDiseaseModeling/idmtools/tree/main/examples/platform_container
+  - emodpy-malaria examples: https://github.com/EMOD-Hub/emodpy-malaria/tree/main/examples-container
+
+
+### Check result with CLI commands
+  ```bash
+  idmtools container status <experiment id>
+  ```
+### Check result files
+    - on host: `<job_directory>/<suite_path>/<experiment_path>/<simulation_path>/`
+    - in container: `/home/container-data/<suite_path>/<experiment_path>/<simulation_path>/`
+
+
+### Folder structure
+By default, `idmtools` now generates simulations with the following structure:
+`job_directory/s_<suite_name>_<suite_uuid>/e_<experiment_name>_<experiment_uuid>/simulation_uuid`
+- `job_directory` — The base directory that contains all suite, experiment, and simulation folders.
+- `s_<suite_name>_<suite_uuid>` — The suite directory, where the suite name (truncated to a maximum of 30 characters) is prefixed with s_, followed by its unique suite UUID.
+- `e_<experiment_name>_<experiment_uuid>` — The experiment directory, where the experiment name (also truncated to 30 characters) is prefixed with e_, followed by its unique experiment UUID.
+- `simulation_uuid` — The simulation folder identified only by its UUID.
+
+Suite is optional. If the user does not specify a suite, the folder will be:
+`job_directory/e_<experiment_name>_<experiment_uuid>/simulation_uuid`
+
+Examples:
+
+If you create a suite named: `my_very_long_suite_name_for_malaria_experiment`
+
+and an experiment named: `test_experiment_with_calibration_phase`
+`idmtools` will automatically truncate both names to a maximum of 30 characters and apply the prefixes s_ for suites and e_ for experiments, resulting in a path like:
+```
+job_directory/
+└── s_my_very_long_suite_name_for_m_12345678-9abc-def0-1234-56789abcdef0/
+    └── e_test_experiment_with_calibrati_abcd1234-5678-90ef-abcd-1234567890ef/
+        └── 7c9e6679-7425-40de-944b-e07fc1f90ae7/
+```
+
+Or for no suite case:
+```
+job_directory/
+└── e_test_experiment_with_calibrati_abcd1234-5678-90ef-abcd-1234567890ef/
+    └── 7c9e6679-7425-40de-944b-e07fc1f90ae7/
+```
+
+Users can customize this structure through the idmtools.ini configuration file:
+- `name_directory = False` — Excludes the suite and experiment names (and their prefixes) from the simulation path.
+- `sim_name_directory = True` — Includes the simulation name in the simulation folder path when name_directory = True.
+
+## Basic CLI commands
+
+**ContainerPlatform** provides several CLI commands to manage and monitor experiments and simulations. Below are some basic commands:
+
+### List running jobs
+
+To list running experiment or simulation jobs:
+  ```bash
+  idmtools container jobs [<container-id>] [-l <limit>] [-n <next>]
+  ```
+
+### Check status
+
+To check the status of an experiment or simulation:
+```bash
+idmtools container status <item-id> [-c <container_id>] [-l <limit>] [--verbose/--no-verbose]
+```
+
+### Cancel job
+
+To cancel an experiment or simulation job:
+```bash
+idmtools container cancel <item-id> [-c <container_id>]
+```
+
+### View Experiments history
+
+To view experiments history:
+```bash
+idmtools container history [<container-id>] [-l <limit>] [-n <next>]
+```
+
+
+## Note
+
+- **WorkItem** is not supported on the Container Platform as it is not needed in most cases since the code already runs on user's local computer.
+- **AssetCollection** creation or referencing to an existing AssetCollection are not supported on the Container Platform with current release. If you've used the COMPS Platform, you may have scripts using these objects. You would need to update these scripts without using these objects in order to run them on the Container Platform.
+- Run with **Singularity** is not needed with Container Platform. If you take existing COMPS example and try to run it with Container Platform, you may need to remove the code that setups the singularity image.

idmtools_platform_container-0.0.2/docker_image/BASE_VERSION

@@ -0,0 +1 @@
+0.0

idmtools_platform_container-0.0.2/docker_image/Dockerfile

@@ -0,0 +1,48 @@
+# FROM docker-production.packages.idmod.org/dtk-rocky-buildenv:0.2-dev
+# Replace the following lines with above line after the offical image is available
+#############################################################
+FROM rockylinux:9.2
+# Set the timezone and the frontend
+ENV TZ=UTC DEBIAN_FRONTEND=noninteractive
+# To suppress warning without altering the installation when pip install with root user
+ENV PIP_ROOT_USER_ACTION=ignore
+# Install the necessary packages
+RUN yum -y install rpm dnf-plugins-core \
+ && yum -y update \
+ && dnf -y install \
+    python3 \
+    python3-devel \
+    mpich \
+    snappy \
+    glibc-devel \
+    epel-release \
+    wget \
+    nano
+
+# Update the system
+RUN yum clean all
+
+RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone # This is for setting up the timezone
+
+# Install pip
+RUN python3 -m pip install pip --upgrade
+# Create a symbolic link to python3
+RUN ln -s /usr/bin/python3 /usr/bin/python
+# Create a directory for pip configurations
+RUN mkdir /root/.pip
+# Copy the pip configuration file
+COPY pip.conf /root/.pip
+
+# Set the path and library path
+ENV PATH ${PATH}:/usr/lib64/mpich/bin
+ENV LD_LIBRARY_PATH ${LD_LIBRARY_PATH}:/usr/lib64/mpich/lib
+
+# Add the requirements file
+ADD requirements.txt /tmp/
+
+# make the PIP index configurable so we can build against staging, production, or a local PyPI server
+ARG CONTAINER_VERSION
+
+# Install the packages
+RUN bash -c "pip3 install -r /tmp/requirements.txt"
+

idmtools_platform_container-0.0.2/docker_image/Dockerfile_buildenv

@@ -0,0 +1,46 @@
+#FROM docker-production.packages.idmod.org/dtk-rocky-buildenv:0.2-dev
+# Replace the following lines with above line after the offical image is available
+#############################################################
+FROM rockylinux:9.2
+ENV TZ=UTC DEBIAN_FRONTEND=noninteractive
+ENV GNUMAKEFLAGS=-j4
+
+RUN yum -y install rpm dnf-plugins-core \
+ && yum -y update \
+ && dnf -y install \
+    python3 \
+    python3-devel \
+    snappy \
+    mpich \
+    sudo \
+    epel-release \
+    git \
+    wget \
+    nano
+
+RUN yum -y update
+RUN yum -y group install "Development Tools" \
+ && yum clean all
+
+RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone # This is for setting up the timezone
+
+RUN python3 -m pip install pip --upgrade
+RUN ln -s /usr/bin/python3 /usr/bin/python
+RUN mkdir /root/.pip
+COPY pip.conf /root/.pip
+# RUN dnf install -y R
+ENV PATH ${PATH}:/usr/lib64/mpich/bin
+ENV LD_LIBRARY_PATH ${LD_LIBRARY_PATH}:/usr/lib64/mpich/lib
+
+#############################################################
+RUN dnf -y install dos2unix
+
+# Add the requirements file
+ADD requirements.txt /tmp/
+
+# make the PIP index configurable so we can build against staging, production, or a local PyPI server
+ARG CONTAINER_VERSION
+
+# Install the packages
+RUN bash -c "pip3 install -r /tmp/requirements.txt"
+

idmtools_platform_container-0.0.2/docker_image/ImageName

@@ -0,0 +1 @@
+container-rocky-runtime

idmtools_platform_container-0.0.2/docker_image/README.md

@@ -0,0 +1,78 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**
+
+- [idmtools_platform_container Docker image](#idmtools_platform_container-docker-image)
+  - [Introduction](#introduction)
+  - [Prerequisites](#prerequisites)
+  - [Build Docker image](#build-docker-image)
+  - [Docker image versioning](#docker-image-versioning)
+  - [Docker image usage](#docker-image-usage)
+  - [Publish Docker image](#publish-docker-image)
+  - [Extend the Docker image](#extend-the-docker-image)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+# idmtools_platform_container Docker image
+
+**Note**: This document is primarily for developers. It is not necessary for users to build and push the Docker image. However, if you wish to use your own Docker image, please follow the instructions below at [Extend the Docker Image](#extend-the-docker-image).
+
+## Introduction
+This Docker image is designed to facilitate idmtools_platform_container. It serves as local running platform with all necessary tools and dependencies installed. The image is based on rockylinux 9.2 and includes the following tools:
+- python 3.9
+- mipch 4.1.1
+- emod-api 1.33.3
+- emod-api's dependencies like numpy, pandas, scipy, matplotlib etc.
+
+## Prerequisites
+- Docker
+  On Windows or Mac, please use Docker Desktop 2.1.0.5 or 2.2.0.1
+
+## Build Docker image
+Note, you do not need to build the image locally. The image is auto built in github action and pushed to idmod artifactory. 
+
+To build Docker image locally, run:
+```bash
+python build_docker_image.py --username <username> --password <password>
+```
+where `<username>` and `<password>` are the username and password for the idmod artifactory account.
+
+You can also build the image with different docker file and image name by specifying `--dockerfile` and `--image_name` arguments.
+```bash
+python build_docker_image.py --username <username> --password <password> --dockerfile Dockerfile_buildenv --image_name container-rocky-buildenv
+```
+which will build image name as 'idm-docker-staging.packages.idmod.org/idmtools/container-rocky-buildenv:x.x.x'
+
+## Docker image versioning
+The Docker image version is determined by the version in idm docker-staging artifactory. It will advance the version number by 0.0.1 for each new build.
+
+## Docker image usage
+By default, you DO NOT need to worry about the image build and how to use image. The image is auto built in github action and pushed to idmod artifactory. The image is used in idmtools_platform_container Platform object. For example, 
+```python
+from idmtools.core.platform_factory import Platform
+platform = Platform('CONTAINER', job_directory='any_dir', docker_image='idm-docker-public.packages.idmod.org/idmtools/container-rocky-runtime:x.x.x')
+```
+where docker_image can be your local built image or the image in idmod artifactory.
+If you do not provide docker_image, the default image will be used.
+
+## Publish Docker image
+Note, you do not need to push docker image to artifactory. The image is auto built in github action and pushed to idmod artifactory.
+If you want to push the image to artifactory, run:
+```bash
+python push_docker_image.py --username <username> --password <password>
+```
+where `<username>` and `<password>` are the username and password for the idmod artifactory account.
+
+## Extend the Docker image
+If you want to build you own Docker image, please use our ``container-rocky-runtime`` as your baseline image and add the following line to the top of your Dockerfile:
+
+```bash
+   FROM docker-production-public/idmtools/container-rocky-runtime/0.0.3
+```
+You can use general Docker build [command](https://docs.docker.com/reference/cli/docker/buildx/build/) to build your own Docker image.
+Then use that image in the Platform object. For example:
+
+```bash
+   from idmtools_platform_container import Platform
+   platform = Platform('CONTAINER', job_directory='any_dir', docker_image='your_own_image_name:x.x.x')
+```

idmtools_platform_container-0.0.2/docker_image/__init__.py

@@ -0,0 +1,6 @@
+"""idmtools comps platform.
+
+Build docker image.
+
+Copyright 2021, Bill & Melinda Gates Foundation. All rights reserved.
+"""