# Install

## Online usage (Binder)

See below for the full installation instructions.
If instead you'd like to use this package online, without needing to install anything, check out our [Binder link](https://mybinder.org/v2/gh/mdtanker/invert4geom/main), which gives full access the the package in an online environment.

This Binder environment can also be accessed by clicking the Binder icon in any of the `gallery` or `tutorial` examples.

## Install Python

Before installing _Invert4Geom_, ensure you have Python 3.11 or greater downloaded.
If you don't, I recommend setting up Python with Miniforge.
See the install instructions [here](https://github.com/conda-forge/miniforge).

## Install _Invert4Geom_ Locally

There are 3 main ways to install `invert4geom`. We show them here in order of simplest to hardest.

### Conda / Mamba

```{note}
`conda` and `mamba` are interchangeable
```

The easiest way to install this package and it's dependencies is with conda or mamba into a new virtual environment:

    mamba create --name invert4geom --yes --force invert4geom --channel conda-forge

Activate the environment:

    mamba activate invert4geom

### Pip

Instead, you can use pip to install `invert4geom`, but first you need to install a few dependencies with conda.
This is because a few dependencies rely on C packages, which can only be install with conda/mamba and not with pip.

Create a new virtual environment:

```
mamba create --name invert4geom --yes --force polartoolkit --channel conda-forge
```

The package `polartoolkit` provides several useful functions used in `invert4geom`.
Since `polartoolkit` has several dependencies that can't be install with `pip` (mostly `pygmt`), it is easiest to install with `conda` or `mamba`.

activate the environment and use `pip` to install `invert4geom`:

```
conda activate invert4geom
pip install invert4geom
```

```{note}
to install the optional dependencies, use this instead:
`pip install invert4geom[all]`
```

### Development version

You can use pip, with the above created environment, to install the latest source from GitHub:

    pip install git+https://github.com/mdtanker/invert4tgeom.git

Or you can clone the git repository and install:


    git clone https://github.com/mdtanker/invert4geom.git
    cd invert4geom
    pip install .

## Test your install

Run the following inside a Python interpreter:

```python
import invert4geom

invert4geom.__version__
```

This should tell you which version was installed.

To further test, you can clone the GitHub repository and run the suite of tests, see the [Contributors Guide](https://invert4geom.readthedocs.io/en/latest/contributing.html).

A simpler method to ensure the basics are working would be to download any of the jupyter notebooks from the documentation and run them locally. On the documentation, each of the examples should have a drop down button in the top right corner to download the `.ipynb`.