Installation

Stable release

To install miranda, run this command in your terminal:

python -m pip install miranda

This is the preferred method to install miranda, as it will always install the most recent stable release.

To make use of remote operations (miranda.remote) and some dataset downloading functions (miranda.ncar miranda.ecmwf), additional libraries are needed. They can can be installed with the following:

python -m pip install miranda[remote]

For better RAM usage when converting datasets, some additional/optional GIS libraries can be installed as well:

python -m pip install miranda[gis]

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for miranda can be downloaded from the Github repo.

1. Download the source code from the Github repo using one of the following methods:

   • Clone the public repository:

     git clone git@github.com:Zeitsperre/miranda.git
     

   • Download the tarball:

     curl -OJL https://github.com/Ouranosinc/miranda/tarball/main
     

2. Once you have a copy of the source, you can install it with:

   python -m pip install .
   

3. When new changes are made to the Github repo, if using a clone, you can update your local copy using the following commands from the root of the repository:

   git fetch
   git checkout main
   git pull origin main
   python -m pip install .
   

   These commands should work most of the time, but if big changes are made to the repository, you might need to remove the environment and create it again.