Installation

The installation of the GSIBerror package can be made through pip or the git repository. In this page, there are presented the methods so the user can choose what best fit their needs.

Warning

Before you begin, make sure you have a Python distribution installed in your computer. To make it easier, it is recommended to install of Miniconda.

Pip

To install GSIBerror package, first create a Python virtual environment using venv and install the package using pip:

python -m venv GSIBerror
source GSIBerror/bin/activate
pip install GSIBerror

It is also possible to use conda to install the GSIBerror package. In the same way demonstrated by using the venv, use conda to create the virtual environment and install the GSIBerror package using pip:

conda create -n GSIBerror python=3.9.18
conda activate GSIBerror
pip install GSIBerror

Note

When you use conda to create a Python virtual environment for the GSIBerror package, it in necessary to indicate which python version must be installed. It will allow the GSIBerror to be used along with its basic dependencies (i.e., xarray, numpy, cartopy e matplotlib). When you use venv, both python and pip are automatically installed.

Repository

In the project repository, there is a file called environment.yml that can be used to create an Anaconda Python environment with all the libraries and packages needed for its use.

To create a Python environment for the GSIBerror package using conda and the environment.yml file, download the latest release and execute the commands:

gh repo clone GAD-DIMNT-CPTEC/GSIBerror
cd GSIBerror
conda env create -f environment.yml

After that, activate the new environment by issuing:

conda activate GSIBerror

Tip

If you want to contribute to the GSIBerror development, it is recommended to install the code using the repository method.

With the installation of the GSIBerror package done, explore the available notebooks in the repository with a demonstration of the package.