Developer installation

Follow the steps below if you will make changes to the idmtools source code to add new functionality.

Install idmtools

1. Install a Git client such as Git Bash or the Git GUI.

2. Open a command prompt and clone the idmtools GitHub repository to a local directory using the following command:

   git clone https://github.com/InstituteforDiseaseModeling/emodpy-idmtools.git
   
   To work from the latest approved code, work from the "master" branch. To work from
   the latest code under active development, work from the "dev" branch.
   

3. 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:

   python -m venv emodpy
   

4. Activate the virtual environment:

   • On Windows, enter the following:

     emodpy\Scripts\activate
     

   • On Linux, enter the following:

     source emodpy/bin/activate
     

5. In the base directory of the cloned GitHub repository, run the setup script.

   • On Windows, enter the following:

     pip install py-make
     pymake setup-dev
     

   • On Linux, enter the following:

     make setup-dev
     

6. To verify that idmtools is installed, enter the following command:

   emodpy --help
   

   You should see a list of available cookie cutter projects and command-line options.

Run tests

If you want to run tests on the code, do the following. You can add new tests to the GitHub repository and they will be run using the same commands. Note that COMPS access is generally restricted to IDM employees.

1. Login to COMPS by navigating to the idmtools root directory and entering the following at a command prompt:

   python dev_scripts\create_auth_token_args.py --comps_url https://comps2.idmod.org --username yourcomps_user --password yourcomps_password
   

2. If you are running the local platform with the nightly idmtools build, enter the following to log in to Docker:

   docker login idm-docker-staging.packages.idmod.org
   

3. Navigate to the directory containing the code you want to test, such as the root directory or a subdirectory like emodpy_platform_comps, enter the following command:

   pymake test-all