Installation

Quickstart

The simplest way to install icepyx is by using the conda package manager. The command below takes care of setting up a virtual environment and installs icepyx along with all the necessary dependencies:

conda create --name icepyx-env --channel conda-forge icepyx

To activate the virtual environment, you can do:

conda activate icepyx-env

Using conda

If you already have a virtual conda environment set up and activated, you can install the latest stable release of icepyx from conda-forge like so:

conda install icepyx

To upgrade an installed version of icepyx to the latest stable release, do:

conda update icepyx

Using pip

Alternatively, you can also install icepyx using pip.

pip install icepyx

Windows users will need to first install Fiona, please look at the instructions there. Windows users may consider installing Fiona using pipwin

pip install pipwin
pipwin install Fiona

Currently, conda and pip packages are generated with each tagged release. This means it is possible that these methods will not install the latest merged features of icepyx. In this case, icepyx is also available for use via the GitHub repository. The contents of the repository can be downloaded as a zipped file or cloned.

To use icepyx this way, fork this repo to your own account, then git clone the repo onto your system. To clone the repository:

git clone https://github.com/icesat2py/icepyx.git

Provided the location of the repo is part of your $PYTHONPATH, you should simply be able to add import icepyx to your Python document. Alternatively, in a command line or terminal, navigate to the folder in your cloned repository containing setup.py and run

pip install -e.