Developer installation#

Follow the steps below if you will use idmtools_platform_local 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_local”, but you may use any desired name:

    python -m venv idmtools_local
    
  2. Activate the virtual environment:

    • For Windows, enter the following:

      idmtools_local\Scripts\activate
      
    • For Linux, enter the following:

      source idmtools_local/bin/activate
      
  3. Clone the repository:

    git clone https://github.com/InstituteforDiseaseModeling/idmtools_local.git
    
  4. Run bootstrap:

    python dev_scripts/bootstrap.py
    
  5. Verify installation by pip list, you should see idmtools_platform_local package:

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

    deactivate