Basic 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. Install idmtools_platform_local packages:

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

    Note

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

  4. Verify installation by pip list, you should see idmtools_platform_local package:

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

    deactivate