Installation

Important

The project is available through Codeberg and is under active developement. Collaboration and feedback are both widely encouraged.

Note

In the following, antenna/receiver will be used interchangeably. They both describe a VLF receiver. Similarly, transmitter/station both refer to a VLF transmitter.

Required files

Somes additional files are necessary to use the package for each new receiver:

  1. The .mau files recorded by the antenna. It is assumed throughout the code that they are produced with a 1s time resolution. If this is not the case, it can be compensated by the time-average variable (see Time resolution and \delta).

  2. The files containing amplitude and phase modelling at the receiver for different values of \(h'\) and \(\beta\) (see Estimating the electron density).

  3. The files containing the mu and sigma values for estimating the solar X-ray flux from the VLF data (see Before using the code).

Installation

To install the library, please use the environment mentionned above. Then, download the file ending in.whland in a console run

pip install path_to_file/file.whl

Troubleshooting

One of the problems I encountered is the installation of the hpy5 package. The exact error I had was:

note: This error originates from a subprocess, and is likely not a problem with pip.
ERROR: Failed building wheel for h5py
Failed to build h5py
error: failed-wheel-build-for-install

(One of) the solution was to run

conda install hpy5

before installing the vlf4ions package.