Basic installation

Follow the steps below if you will use idmtools to run and analyze simulations, but will not make source code changes.

1. Open a command prompt and create a virtual environment in any directory you choose. The command below names the environment “idmtools”, but you may use any desired name:

   python -m venv idmtools
   

2. Activate the virtual environment:

   • On Windows, enter the following:

     idmtools\Scripts\activate
     

   • On Linux, enter the following:

     source idmtools/bin/activate
     

3. Install idmtools packages:

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

   If you are on Python 3.6, also run:

   pip install dataclasses
   

   Note

   When reinstalling idmtools you should use the --no-cache-dir and --force-reinstall options, such as: pip install idmtools[idm] --index-url=https://packages.idmod.org/api/pypi/pipi-production/simple --no-cache-dir --force-reinstall. Otherwise, you may see the error, idmtools not found, when attempting to open and run one of the example Python scripts.

4. Verify installation by pulling up idmtools help:

   idmtools --help
   

5. When you are finished, deactivate the virtual environment by entering the following at a command prompt:

   deactivate