Skip to content

Using idmlaser as a pip installable module

Jonathan Bloedow edited this page Jul 5, 2024 · 2 revisions

Purpose

The purpose of this document is to explain how to work with a pip installable idmlaser module.

User Mode

Installation

pip3 install idmlaser

Note that you should have your .pipconf set up to already point to IDM Artifactory.

$ cat !$
cat ~/.pip/pip.conf
[global]
index-url = https://packages.idmod.org/api/pypi/pypi-production/simple

If for some reason you can't configure your computer that way, you can do:

pip3 install idmlaser -i https://packages.idmod.org/api/pypi/pypi-production/simple

Developer Mode

Installation

git clone -b jb_modulify --single-branch https://github.com/InstituteforDiseaseModeling/laser.git
cd jb
pip3 install -e .

Setup

$ python3 -m idmlaser.utils.build_template_workspace
Enter the sandbox directory path (default: /var/tmp/sandbox):

Walk through the prompts. Everything should work whichever options you pick.

Run

pushd /var/tmp/sandbox

Or whatever path you chose.

python3 -m idmlaser.measles
Clone this wiki locally