# Installation

## Requirements

- Python 3.12 or later
- A valid Ionworks API key (see {doc}`authentication`)

## Install from PyPI

Install the package using pip:

```bash
pip install ionworks
```

Or with [uv](https://docs.astral.sh/uv/):

```bash
uv pip install ionworks
```

`ionworks` cannot share an environment with the older `ionworks-api` package. See
{doc}`../../migration` if you are upgrading.

## Verify the installation

Check that the package is installed correctly:

```python
import ionworks as iw

print(iw.__version__)
```

## Next steps

Once installed, head to {doc}`authentication` to configure your API credentials.