Packages Status

Other status

IDM Modeling Tools

Table of Contents

• User Installation
  • Recommended install
  • Advanced Install
  • Installing Development/Early Release Versions
    • PyPI
  • Pre-requisites
• Reporting issues
• Requesting a feature
• Development Documentation

User Installation

Documentation is located at https://docs.idmod.org/projects/idmtools/en/latest/.

To build the documentation locally, do the following:

1. Create and activate a venv.

2. Navigate to the root directory of the repo and enter the following:

   pip install -r dev_scripts/package_requirements.txt
   pip install -r docs/requirements.txt
   python dev_scripts/bootstrap.py
   cd docs
   make html
   

3. (Optional) To automatically serve the built docs locally in your browser, enter the following from the root directory:

   python dev_scripts/serve_docs.py
   

Recommended install

The recommended install is to use

pip install idmtools[full] --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple

This will install the core tools, the cli, the comps and local platforms, support for EMOD models, and python models

If you do not need the local platform, you can use the following command

pip install idmtools[idm] --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple

This will install the core tools, the cli, the comps, support for EMOD models, and python models

Advanced Install

You can also install just the individual packages to create minimal environments

• pip install idmtools --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple - Core package
• pip install idmtools-cli --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple - Adds the idmtools cli commands
• pip install idmtools-platform-comps --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple - Support for COMPS
• pip install idmtools-platform-local --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple - Support for Local Platform
• pip install idmtools-models --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple - Python and generic models

Installing Development/Early Release Versions

Development versions are available through both IDM's pypi registry and through Github.

PyPI

If you have your authentication defined in your pip.conf or pip.ini file, you can use the following commands to install from staging

• pip install idmtools --index-url=https://<USERNAME>:<PASSWORD>@packages.idmod.org/api/pypi/pypi-staging/simple - Core package
• pip install idmtools-cli --index-url=https://<USERNAME>:<PASSWORD>@packages.idmod.org/api/pypi/pypi-staging/simple - Adds the idmtools cli commands
• pip install idmtools-platform-comps --index-url=https://<USERNAME>:<PASSWORD>@packages.idmod.org/api/pypi/pypi-staging/simple - Support for COMPS
• pip install idmtools-platform-local --index-url=https://<USERNAME>:<PASSWORD>@packages.idmod.org/api/pypi/pypi-staging/simple - Support for Local Platform
• pip install idmtools-models --index-url=https://<USERNAME>:<PASSWORD>@packages.idmod.org/api/pypi/pypi-staging/simple - Python and generic models

Pre-requisites

• Python 3.7/3.8/3.9/3.10/3.11 x64
• Docker(Required for the local platform) On Windows or Mac, please use Docker Desktop 2.1.0.5 or 2.2.0.1

Reporting issues

Include the following information in your post:

• Describe what you expected to happen.
• If possible, include a minimal reproducible example to help us identify the issue. This also helps check that the issue is not with your own code.
• Describe what actually happened. Include the full traceback if there was an exception.

You can report an issue directly on GitHub or by emailing [email protected]. Please include steps to reproduce the issue

Requesting a feature

You can request a feature but opening a ticket on the repo or by emailing [email protected]

Development Documentation

See DEVELOPMENT_README.md