Getting Started: Installation

This guide walks you through installing and using the seagliderOG1 Python package. It includes:

Basic installation via pip (for most users)
Cloning the repo for custom use or development
Setup for contributors

Option 1: Install via `pip` (recommended for most users)

If you just want to use the package without modifying the code:

pip install seagliderOG1

Then in your Python scripts or notebooks:

import seagliderOG1

💡 You can install into a virtual environment (e.g. using venv, conda, or micromamba) to keep things clean.

Option 2: Clone for custom use

If you want a local editable copy of the code, for example to adapt it to your own purposes:

a. Clone the repository to your computer

From a terminal:

git clone https://github.com/ifmeo-hamburg/seagliderOG1
cd seagliderOG1

Or using Github Desktop:

Visit https://github.com/ifmeo-hamburg/seagliderOG1
Click the green <> Code button
Choose Open with GitHub Desktop

💡 Rename the folder if desired.

b. Set up a Python environment and install

python3 -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
pip install -r requirements.txt
pip install -e . # Editable install

Option 3: Contribute to the project

To contribute to development:

Fork the repository on GitHub
Clone your fork locally
Set up a virtual environment and install dev tools:

pip install -r requirements-dev.txt

Run tests:

pytest

For full guidance on contributing to a project like seagliderOG1, see https://eleanorfrajka.github.io/template-project/gitcollab.html.