idmtools-platform-comps 0.0.0.dev0__tar.gz → 0.0.3__tar.gz

idmtools_platform_comps-0.0.3/.bumpversion.cfg

@@ -0,0 +1,33 @@
+[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:part:build]
+
+[bumpversion:file:VERSION]
+serialize = {major}.{minor}.{patch}
+
+[bumpversion:file:./idmtools_platform_comps/__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_comps-0.0.3/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_comps-0.0.3/MANIFEST.in

@@ -0,0 +1,5 @@
+include README.md
+include idmtools_platform_comps/utils/base_singularity_work_order.json
+include LICENSE.TXT
+prune tests
+prune prototypes

idmtools_platform_comps-0.0.3/Makefile

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

idmtools_platform_comps-0.0.3/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: idmtools_platform_comps
+Version: 0.0.3
+Summary: Comps 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<1.0.0,>=0.0.0
+Requires-Dist: pyCOMPS~=2.11
+Requires-Dist: natsort~=8.4.0
+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-comps](https://github.com/InstituteforDiseaseModeling/idmtools/workflows/Staging:%20idmtools-platform-comps/badge.svg?branch=dev)
+
+# idmtools-platform-comps
+
+<!-- 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**
+
+  - [Installing](#installing)
+- [Development Tips](#development-tips)
+- [Building SSMT Docker Image](#building-ssmt-docker-image)
+- [Choose SSMT Docker Image to use in test/script](#choose-ssmt-docker-image-to-use-in-testscript)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Installing
+
+```bash
+pip install idmtools-platform-comps --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple
+```
+
+# Development Tips
+
+There is a Makefile file available for most common development tasks. Here is a list of commands
+```bash
+clean       -   Clean up temproary files
+lint        -   Lint package and tests
+test        -   Run All tests
+coverage    -   Run tests and generate coverage report that is shown in browser
+```
+On Windows, you can use `pymake` instead of `make`
+
+# Building SSMT Docker Image
+
+To build the SSMT Docker image, follow these steps
+
+1. ```bash
+   docker login docker-production.packages.idmod.org
+   ```
+2. ```bash
+   make ssmt-image
+   ```
+3. When prompted, enter your idm username and password
+
+# Choose SSMT Docker Image to use in test/script
+
+There are three ways to choose which ssmt docker image to use in your script:
+
+1. specify docker_image in SSMTWorkItem creation, for example,
+```bash
+   wi = SSMTWorkItem(name=wi_name, command=command, docker_image='my_test_ssmt_docker_image')
+```   
+2. define docker_image in your idmtools.ini, for example:
+```bash
+    [COMPS2]
+    type = COMPS
+    endpoint = https://comps.idmod.org
+    environment = Calculon
+    ......
+    docker_image = my_test_ssmt_docker_image
+```
+
+3. if not above two cases, idomtools system will determine the default ssmt docker image from platform for you:
+
+   if endpoint = https://comps.idmod.org, it will use production docker image
+   
+   for all other cases, it will use the staging docker image
+   
+Note: if user overrode docker image in wi (case #1) and also defined docker image in idmtools.ini (case #2), 
+      it will take #1 as higher priority

idmtools_platform_comps-0.0.3/README.md

@@ -0,0 +1,70 @@
+![Staging: idmtools-platform-comps](https://github.com/InstituteforDiseaseModeling/idmtools/workflows/Staging:%20idmtools-platform-comps/badge.svg?branch=dev)
+
+# idmtools-platform-comps
+
+<!-- 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**
+
+  - [Installing](#installing)
+- [Development Tips](#development-tips)
+- [Building SSMT Docker Image](#building-ssmt-docker-image)
+- [Choose SSMT Docker Image to use in test/script](#choose-ssmt-docker-image-to-use-in-testscript)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Installing
+
+```bash
+pip install idmtools-platform-comps --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple
+```
+
+# Development Tips
+
+There is a Makefile file available for most common development tasks. Here is a list of commands
+```bash
+clean       -   Clean up temproary files
+lint        -   Lint package and tests
+test        -   Run All tests
+coverage    -   Run tests and generate coverage report that is shown in browser
+```
+On Windows, you can use `pymake` instead of `make`
+
+# Building SSMT Docker Image
+
+To build the SSMT Docker image, follow these steps
+
+1. ```bash
+   docker login docker-production.packages.idmod.org
+   ```
+2. ```bash
+   make ssmt-image
+   ```
+3. When prompted, enter your idm username and password
+
+# Choose SSMT Docker Image to use in test/script
+
+There are three ways to choose which ssmt docker image to use in your script:
+
+1. specify docker_image in SSMTWorkItem creation, for example,
+```bash
+   wi = SSMTWorkItem(name=wi_name, command=command, docker_image='my_test_ssmt_docker_image')
+```   
+2. define docker_image in your idmtools.ini, for example:
+```bash
+    [COMPS2]
+    type = COMPS
+    endpoint = https://comps.idmod.org
+    environment = Calculon
+    ......
+    docker_image = my_test_ssmt_docker_image
+```
+
+3. if not above two cases, idomtools system will determine the default ssmt docker image from platform for you:
+
+   if endpoint = https://comps.idmod.org, it will use production docker image
+   
+   for all other cases, it will use the staging docker image
+   
+Note: if user overrode docker image in wi (case #1) and also defined docker image in idmtools.ini (case #2), 
+      it will take #1 as higher priority

idmtools_platform_comps-0.0.3/VERSION

@@ -0,0 +1 @@
+3.0.0

idmtools_platform_comps-0.0.3/idmtools_platform_comps/__init__.py

@@ -0,0 +1,25 @@
+"""idmtools comps platform.
+
+We try to load the CLI here but if idmtools-cli is not installed, we fail gracefully.
+
+Copyright 2021, Bill & Melinda Gates Foundation. All rights reserved.
+"""
+# flake8: noqa F821
+from idmtools_platform_comps.plugin_info import COMPSPlatformSpecification
+try: # since cli is not required but we always try to load file, wrap in try except
+    from idmtools_platform_comps.comps_cli import CompsCLI
+except ImportError:
+    pass
+
+try:
+    from importlib.metadata import version, PackageNotFoundError
+except ImportError:
+    # Python < 3.8
+    from importlib_metadata import version, PackageNotFoundError
+
+try:
+    __version__ = version("idmtools-platform-comps")  # Use your actual package name
+except PackageNotFoundError:
+    # Package not installed, use fallback
+    __version__ = "0.0.0+unknown"
+

idmtools_platform_comps-0.0.3/idmtools_platform_comps/cli/__init__.py

@@ -0,0 +1,4 @@
+"""idmtools comps cli module.
+
+Copyright 2021, Bill & Melinda Gates Foundation. All rights reserved.
+"""

idmtools_platform_comps-0.0.3/idmtools_platform_comps/cli/cli_functions.py

@@ -0,0 +1,50 @@
+"""idmtools cli utils.
+
+Copyright 2021, Bill & Melinda Gates Foundation. All rights reserved.
+"""
+from dataclasses import Field
+from typing import Dict, Tuple
+
+
+def validate_range(value: float, min: float, max: float) -> Tuple[bool, str]:
+    """
+    Function used to validate an integer value between min and max.
+
+    Args:
+        value: The value set by the user
+        min: Minimum value
+        max: Maximum value
+
+    Returns: tuple with validation result and error message if needed
+    """
+    if min <= value <= max:
+        return True, ''
+    return False, f"The value needs to be between {min} and {max}"
+
+
+def environment_list(previous_settings: Dict, current_field: Field) -> Dict:
+    """
+    Allows the CLI to provide a list of available environments.
+
+    Uses the previous_settings to get the endpoint to query for environments
+
+    Args:
+        previous_settings: previous settings set by the user in the CLI.
+        current_field: Current field specs
+
+    Returns: updates to the choices and default
+    """
+    from COMPS import Client
+    Client.login(previous_settings["endpoint"])
+    client = Client.get("environments")
+    environment_choices = []
+    for environment_info in client.json()["Environments"]:
+        environment_choices.append(environment_info["EnvironmentName"])
+
+    # Set a valid default
+    if current_field.default not in environment_choices:
+        default_env = environment_choices[0]
+    else:
+        default_env = current_field.default
+
+    return {"choices": environment_choices, "default": default_env}