Installation

Requirements

SeaSenseLib requires Python 3.7 or later and depends on several scientific Python packages:

The easiest way to install SeaSenseLib is using pip:

pip install seasenselib

This will install SeaSenseLib and all required dependencies.

If you want to contribute to the project or modify the code, follow these steps:

Clone the repository:

git clone https://github.com/ocean-uhh/seasenselib.git
cd seasenselib

Create and activate a virtual environment:

On Linux/macOS:

python3 -m venv venv
source venv/bin/activate

On Windows (CMD):

python -m venv venv
venv\Scripts\activate.bat

On Windows (PowerShell):

python -m venv venv
venv\Scripts\Activate.ps1

Install in development mode:
```
pip install --upgrade pip setuptools wheel
pip install -e ".[dev]"
```
This installs SeaSenseLib in “editable” mode along with development dependencies like pytest and sphinx.

Using Makefile (requires pipenv):

If you have pipenv installed, you can use the provided Makefile:

make setup
make install

Manual dependency installation:

If you prefer to manage dependencies manually:

pip install -r requirements.txt
pip install -e .

Test that the installation works correctly:

Test the command-line interface:

seasenselib --help

This should display the available commands and options.

Test the Python library:

import seasenselib
from seasenselib.readers import SbeCnvReader
print("SeaSenseLib installed successfully!")

Run the test suite (development installation only):

python -m unittest discover tests/

Common Issues:

Missing dependencies: If you encounter import errors, ensure all dependencies are installed:
```
pip install -r requirements.txt
```
Permission errors: On some systems, you may need to use pip install --user to install packages in your user directory.
Python version: Ensure you’re using Python 3.7 or later:
```
python --version
```
Virtual environment issues: If you’re having trouble with virtual environments, try deactivating and recreating:
```
deactivate
rm -rf venv
python3 -m venv venv
source venv/bin/activate
```

Getting Help:

If you encounter installation issues: