emod-api installation#

Follow the steps below to install emod-api.

Prerequisites#

First, ensure the following prerequisites are met.

Windows 10 Pro or Enterprise, Linux, or Mac
Python 3.9 64-bit (https://www.python.org/downloads/release)

A file that indicates the pip index-url:

For Windows, in C:\Users\Username\pip\pip.ini add the following:
[global]
index-url = https://packages.idmod.org/api/pypi/pypi-production/simple
For Linux, in $HOME/.config/pip/pip.conf add the following:
[global]
index-url = https://packages.idmod.org/api/pypi/pypi-production/simple

Installation instructions#

Open a command prompt and create a virtual environment in any directory you choose. The command below names the environment “v-emod-api”, but you may use any desired name:
```
python -m venv v-emod-api
```
Activate the virtual environment:
- For Windows, enter the following:
```
v-emod-api\Scripts\activate
```
- For Linux, enter the following:
```
source v-emod-api/bin/activate
```
Install emod-api packages:
```
pip install emod-api
```
If you are on Linux, also run:
```
pip install keyrings.alt
```
When you are finished, deactivate the virtual environment by entering the following at a command prompt:
```
deactivate
```

Windows#

To properly install Shapely on Windows and/or if Snappy compression support is desired or needed, consider downloading and installing the latest python-snappy package for Windows from Christoph Gohlke’s python package website.