Installation

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

pip install amisrsynthdata

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

pip install amisrsynthdata[plots]

The amisrsynthdata package depends on apexpy, which should be installed automatically. Historically, this package has sometimes been challenging to install on some computer systems. If the installation of amisrsynthdata fails because apexpy fails to install, or amisrsynthdata crashed due to an apexpy error, consider manually installing apexpy first following the apexpy installation instructions, then reinstalling amisrsynthdata as shown above.

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 installing with the ``plots’’ option, the following additional packages are also required and will be installed:

• matplotlib

• cartopy

If automatic installation of any of these packages fail, try installing them in your environment manually referring to instructions and tips from that package’s documentation.

Utilizing output from the GEMINI non-linear ionospheric dynamics model to specify the ionospheric state requires pygemini to be installed. This is a specialized option and interested users should install this package manually using instructions in its README file before attempting to run `amisrsynthdata’ with GEMINI configuration option.