Installation

Python environment and IDEs¶

A conda environment is recommended. The easiest way to set up a conda environment is to install Anaconda. For instructions, see Installing Anaconda Distribution. After installation, a conda virtual environment can be created by, e.g.,

conda create --name YOUR_ENV_NAME -c conda-forge python=3.12 cython spyder

After creating the virtual environment, one needs to activate it:

conda activate YOUR_ENV_NAME

Python IDEs¶

Popular Python IDEs include Spyder, PyCharm, and VS Code. Choose one of them based on your preference and install it. For example,

• to install Spyder, see Installing Spyder.

• to install PyCharm, see Installing PyCharm.

• to install VS Code, see Installing Visual Studio Code.

Operating Systems¶

GeospaceLAB is compatible with Windows, macOS, and Linux. The installation process may vary slightly depending on the operating system. Please refer to the respective documentation for any OS-specific instructions. If Windows users encounter issues with the installation, it is recommended to use the Windows Subsystem for Linux (WSL) to create a Linux environment on their Windows machine. For more information on WSL, see Windows Subsystem for Linux Installation Guide and VS Code Remote - WSL.

Install GeospaceLAB¶

Install GeospaceLAB via PyPI:

pip install geospacelab

To upgrade GeospaceLAB:

pip install -U geospacelab

Dependencies¶

Most of the dependencies are installed when the package is installed. A few packages can be installed manually.

For example, the Cartopy package is useful for processing and mapping geospatial data. To install Cartopy, see Installing Cartopy.

Another useful package is ApexPy, which provides a Python interface to the Apex coordinate system. To install ApexPy, see Installing ApexPy.

To use the VirES and HAPI services, install the viresclient:

pip install viresclient

and the hapiclient:

pip install hapiclient