Installation

The amisrsynthdata package is pure python and can be installed easily with pip.

pip install amisrsynthdata

This assumes you already have apexpy installed. If you do not, either install it manually or use the apex option.

pin install amisrsynthdata[apex]

If you would like create the optional summary plots, you will need to install with the plots option.

pin install amisrsynthdata[plots]

Development

To install amisrsynthdata for development (adding features or fixing bugs):

1. Fork amisrsynthdata on GitHub.

2. Clone your fork locally

git clone git@github.com:your_name_here/amisrsynthdata.git

3. Install with the editable flag

cd amisrsynthdata
pip install -e .

Note that the installation options discussed above can be used here as well.

Requirements

The following additional packages are required and will be installed:

• numpy

• h5py

• pymap3d

• apexpy

• pyyaml

• importlib-resources (for python < 3.9)

If automatic installation of any of these packages fail, try installing it in your environment manually referring to instructions and tips from that package’s documentation. Additionally, matplotlib and cartopy are required to create the optional summary plots. Utilizing output from the GEMINI non-linear ionospheric dynamics model requires pygemini be installed.