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. .. _additional_files: 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 :py:obj:`time-average` variable (see :ref:`time-average`). 2. The files containing amplitude and phase modelling at the receiver for different values of :math:`h'` and :math:`\beta` (see :ref:`LMP`). 3. The files containing the :py:obj:`mu` and :py:obj:`sigma` values for estimating the solar X-ray flux from the VLF data (see :ref:`pre_flux_est`). Installation -------------------- To install the library, please use the environment mentionned above. Then, download the file ending in\ ``.whl``\ and in a console run .. code-block:: ruby 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: .. code-block:: ruby 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 .. code-block:: ruby conda install hpy5 before installing the `vlf4ions` package.