.. _install:

Installation
============

The following instructions will allow you to install pysatSpaceWeather.


.. _install-prereq:

Prerequisites
-------------

.. image:: figures/poweredbypysat.png
    :width: 150px
    :align: right
    :alt: powered by pysat Logo, blue planet with orbiting python


pysatSpaceWeather uses common Python modules, as well as modules developed by
and for the Space Physics community.  This module officially supports
Python 3.9+.

 ============== =================
 Common modules Community modules
 ============== =================
  netCDF4        pysat >= 3.2.0
  numpy
  pandas
  requests
  xarray
 ============== =================


.. _install-opt:


Installation Options
--------------------


.. _install-opt-pip:

PyPi
^^^^
All official pysatSpaceWeather releases are
`available <https://pypi.org/project/pysatSpaceWeather/>`_ through the PyPi
package manager.
::


   pip install pysatSpaceWeather



.. _install-opt-git:

GitHub
^^^^^^
You can keep up to date with the latest changes at the GitHub repository.

1. Clone the git repository
::


   git clone https://github.com/pysat/pysatSpaceWeather.git


2. Install pysatSpaceWeather:
   Change directories into the repository folder and run the setup.py file.
   There are a few ways you can do this:

   A. Install on the system (will install locally without root privileges)::


        python -m build
	pip install .
   C. Install with the intent to develop locally::


        python -m build
	pip install -e .