Repository files navigation

Documentation available athttps://docs.idmod.org/projects/emodpy/en/latest/.

To build the documentation locally, do the following:

1. Create and activate a venv.

2. Navigate to the root directory of the repo and enter the following

   pip install -r requirements.txtcd docspip install -r requirements.txtcd ..pip install -e .

Table of Contents

• User Installation
  • Pre-requisites
• Development Environment Setup
  • First Time Setup
  • Development Tips
  • To run examples or tests
  • Building docs
• Community
• Disclaimer

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

• Python 3.6/3.7 x64

When setting up your environment for the first time, you can use the following instructions

1. Clone the repository:

   > git clone https://github.com/InstituteforDiseaseModeling/emodpy.git

2. Create a virtualenv. On Windows, please use venv to create the environmentpython -m venv idmtoolsOn Unix(Mac/Linux) you can use venv or virtualenv
3. Activate the virtualenv
4. If you are on windows, runpip install py-make --upgrade --force-reinstall
5. Then runpython ./.dev_scripts/bootstrap.py. This will install all the tools.

There is a Makefile file available for most common development tasks. Here is a list of commands

clean       -   Clean up temproary fileslint        -   Lint package and teststest        -   Run All testscoverage    -   Run tests and generate coverage report that is shownin browser

On Windows, you can usepymake instead ofmake

First, install idmtools packages including emodpy package from idm artifactory

staging artifactory with nightly build packages:

pip install idmtools[idm] --index-url=https://email:password@packages.idmod.org/api/pypi/pypi-staging/simpleORpip install idmtools[full] --index-url=https://email:password@packages.idmod.org/api/pypi/pypi-staging/simple

[idm] option will install all idmtools packages except idmtools_platform_local package

[full] option will install all idmtools packages including idmtools_platform_local package

email:password is your company login credentials. password should be encoded for specially characters

production artifactory with latest release packages:

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

To run integration tests or examples, you also need to install idmtools-test package

pip install idmtools-test --index-url=https://email:password@packages.idmod.org/api/pypi/pypi-staging/simpleORpip install idmtools-test --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple

Install all necessary documentation tools usingpip install -r doc/requirements.txt and install emodpy in the same environment. Navigate to the docs folder and entermake html. If you make updates to the docstrings, you must reinstall emodpy to pick up the latest changes in the documentation build. It's also good practice to runmake clean before rebuilding the documentation to avoid missing errors or warnings. These steps are only for testing the build locally before committing changes. The documentation build on Read the Docs will run automatically when new code is committed.

The EMOD Community is made up of researchers and software developers, primarily focused on malaria and HIV research.We value mutual respect, openness, and a collaborative spirit. If these values resonate with you,we invite you to join our EMOD Slack Community by completing this form:

https://forms.office.com/r/sjncGvBjvZ

The code in this repository was developed by IDM and other collaborators to support our joint research on flexible agent-based modeling.We've made it publicly available under the MIT License to provide others with a better understanding of our research and an opportunity to build upon it fortheir own work. We make no representations that the code works as intended or that we will provide support, address issues that are found, or accept pull requests.You are welcome to create your own fork and modify the code to suit your own modeling needs as permitted under the MIT License.