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 “emodpy”, but you may use any desired name, and any available path you prefer:

   python -m venv /path/to/venv/root/emodpy
   

2. Activate the virtual environment:

   • On Windows, enter the following:

     \path\to\venv\root\emodpy\Scripts\activate
     

   • On Linux, enter the following:

     source /path/to/venv/root/emodpy/bin/activate
     

3. Install idmtools packages.

   pip install emodpy --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple
   

   (It’s strongly recommended that you edit your pip.ini or pip.conf so you don’t have to specificy –index-url.)

4. Verify installation by doing a test import:

   python -c 'import emodpy'
   

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

   deactivate