# Installation


## Option 1: Clone this repository
To copy the repository for your own purposes (including to suggest edits):

1. Clone caldip to your local machine:
    With a command line usage of git, this looks like:
    ```
    git clone https://github.com/ocean-uhh/caldip
    ```

    Alternatively, in your web browser, navigate to https://github.com/ocean-uhh/caldip and click the green button "<> Code" for a dropdown menu of options.  Choose, e.g. "Open with GitHub Desktop".  This requires the application "GitHub Desktop" (https://github.com/apps/desktop).  See instructions [here](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository).
2. Change to the parent directory of `caldip` on your local machine
3. Install the package locally
```
pip install -e ".[dev]"
```

## Option 2: Install with pip (or uv)

```
pip install caldip
# or, with uv:
uv pip install caldip     # into the active environment
uv tool install caldip    # as a standalone command-line tool
```