# Installation

[<img src="https://raster.shields.io/pypi/v/seapig.png" class="img-fluid" alt="PyPI" />](https://pypi.org/project/seapig/) [<img src="https://img.shields.io/conda/vn/conda-forge/seapig.svg" class="img-fluid" alt="Conda Version" />](https://anaconda.org/channels/conda-forge/packages/seapig/overview)

------------------------------------------------------------------------


# Install seapig

seapig is available on PyPI and conda-forge.


## Quick start

To install the minimal installation from PyPi run:

``` bash
pip install seapig
```

`seapig` can aslo be installed with conda:

``` bash
conda install -c conda-forge seapig
```

or with mamba:

``` bash
mamba install -c conda-forge seapig
```

This installs the core library and its required dependencies.


## Installation options

Choose an installation option based on your use case:

| Option | Use case |
|----|----|
| `seapig` | Minimal install with core functionality |
| `seapig[suggested]` | Recommended for end users who want additional optional features |
| `seapig[dev]` | For contributors: includes tests, linters, and type-checkers |
| `seapig[docs]` | For building documentation locally (requires quarto-cli and other tools) |
| `seapig[all]` | Everything above combined |


## Examples

Install the recommended version with optional features:

``` bash
pip install seapig[suggested]
```

Set up a development environment for contributing:

``` bash
pip install seapig[dev]
```

Get everything (all extras):

``` bash
pip install seapig[all]
```