Installation#

At the command line, enter:

$ 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:

$ pip install miranda[remote]

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

$ 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.

You can either clone the public repository:

$ git clone git://github.com/Ouranosinc/miranda

Or download the tarball:

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

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

$ python setup.py install

Alternatively, you can also install a local copy via pip:

$ pip install .

Creating a Conda environment#

To create a conda development environment including all miranda dependencies, enter the following command from within your cloned repo:

$ conda create -n my_miranda_env python=3.8 --file=environment.yml
$ conda activate my_miranda_env
$ pip install -e .[dev]