===============
Getting Started
===============

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

Via Pip
-------

GeoSpatialTools is not available on PyPI, however it can be installed via pip with the following command:

.. code-block:: console

   pip install git+ssh://git@git.noc.ac.uk/nocsurfaceprocesses/geospatialtools.git

From Source
-----------

Alternatively, you can clone the repository and install using pip (or conda if preferred).

.. code-block:: console

   git clone git@git.noc.ac.uk/nocsurfaceprocesses/geospatialtools.git
   cd geospatialtools
   python -m venv venv
   source venv/bin/activate
   pip install -e .