# Installation
.. sidebar:: Installation

Everything you need to know to start using SpaceSense's library.

---
**NOTE**

We highly recommend to use a virtual environment such as <a href="https://docs.python.org/3/library/venv.html" target="_blank">venv</a> or <a href="https://docs.conda.io/en/latest/" target="_blank">conda</a>.

---

## Pre-requisites

* <a href="https://www.python.org/downloads/release/python-370/" target="_blank">Python 3.7</a> should already be installed on your system.

## Installing with Venv

### On Linux/macOS

Create a virtual environment

```console
python3.7 -m venv venv
```

Activate the virtual environment

```console
source venv/bin/activate
```

Upgrade pip & setuptools

```console
python -m pip install --upgrade pip
pip install -U setuptools
```

Install the latest version of the client library

```console
pip install -U spacesense
```

### On Windows

Create a virtual environment

If you installed
<a href="https://www.microsoft.com/en-us/p/python-37/9nj46sx7x90p#activetab=pivot:overviewtab" target="_blank">Python 3.7 from Microsoft store</a>
then you should be able to run the following command:

```console
python3.7 -m venv venv
```

If you downloaded python 3.7 from python.org then you should run this command instead:

```console
python -3.7 -m venv venv
```

Activate the virtual environment

```console
venv\Scripts\activate
```

Upgrade pip & setuptools

```console
python -m pip install --upgrade pip
pip install -U setuptools
```

Install the latest version of the client library

```console
pip install -U spacesense
```

And you are now ready to go.

NOTE: if you get this error when installing the library with pip please refer to the [fix gdal dependencies](fix-gdal-dependencies) section.

```console
(venv) PS C:\Users\user\my-project> pip install -U spacesense
...
14      ERROR: A GDAL API version must be specified. Provide a path to gdal-config using a GDAL_CONFIG environment variable or use a ...
...
```

(fix-gdal-dependencies)=
### Fix gdal dependencies

1. Download those two wheel files.(Chose depending on your CPU)
    1. For AMD CPU
        * Wheel for GDAL: [GDAL-3.4.1-cp37-cp37m-win_amd64.whl](./resources/GDAL-3.4.1-cp37-cp37m-win_amd64.whl)
        * Wheel for rasterio: [rasterio-1.2.10-cp37-cp37m-win_amd64.whl](./resources/rasterio-1.2.10-cp37-cp37m-win_amd64.whl)
    2. For Intel CPU
        * Wheel for GDAL: [GDAL-3.4.1-cp37-cp37m-win32.whl](./resources/GDAL-3.4.1-cp37-cp37m-win32.whl)
        * Wheel for rasterio: [rasterio-1.2.10-cp37-cp37m-win32.whl](./resources/rasterio-1.2.10-cp37-cp37m-win32.whl)
2. Move the two wheels to a new folder called "libs" at the root of your project
3. build the wheels (make sure you are in your virtual environment created above)
    1. For AMD CPU

    ```console
    pip install libs\GDAL-3.4.1-cp37-cp37m-win_amd64.whl libs\rasterio-1.2.10-cp37-cp37m-win_amd64.whl
    ```

    1. For Intel CPU

    ```console
    pip install libs\GDAL-3.4.1-cp37-cp37m-win32.whl libs\rasterio-1.2.10-cp37-cp37m-win32.whl
    ```

4. Install SpaceSense library with pip

    ```console
    pip install -U spacesense
    ```

    you are now ready to go.

---

## Installing with Anaconda

### On Linux/macOS

Create a virtual environment

```console
conda create --name myenv python=3.7
```

Activate the virtual environment

```console
conda activate myenv
```

Install the latest version of the client library

```console
pip install -U spacesense
```

you are now ready to go.

### On Windows

Create a virtual environment

```console
conda create --name myenv python=3.7
```

Activate the virtual environment

```console
conda activate myenv
```

Upgrade install rasterio

```console
conda install -c conda-forge rasterio
```

Install the latest version of the client library

```console
pip install -U spacesense
```

you are now ready to go.

---

We want to make sure this project is as easy as possible to install.
If something is not working as intended, make sure to let us know at support@spacesense.ai.