Merge pull request #50 from ocean-uhh/49-renaming

Feat: Project renaming

Author: ysorge

.github/workflows/ci.yml

@@ -30,7 +30,7 @@ jobs:
         pip install pytest
         pip install -r requirements.txt
 
-    - name: Install CTD Tools in development mode
+    - name: Install SeaSenseLib in development mode
       run: |
         pip install -e .
 

.github/workflows/docs.yml

@@ -37,7 +37,7 @@ jobs:
         if [ -f requirements-dev.txt ]; then pip install -r requirements-dev.txt; fi
 
 
-    - name: Install ctd_tools
+    - name: Install seasenselib
       shell: bash -l {0}
       run: |
         python -m pip install -e . --no-deps --force-reinstall

.github/workflows/docs_deploy.yml

@@ -32,7 +32,7 @@ jobs:
         python -m pip install flake8 pytest
         if [ -f requirements-dev.txt ]; then pip install -r requirements-dev.txt; fi
   
-    - name: Install ctd_tools
+    - name: Install seasenselib
       shell: bash -l {0}
       run: |
         python -m pip install -e . --no-deps --force-reinstall

.gitignore

@@ -42,4 +42,4 @@ target/
 # Package builder
 dist/
 build/
-ctd_tools.egg-info/
+seasenselib.egg-info/

Makefile

@@ -88,17 +88,17 @@ release: build
 	git push origin "v$$VERSION" 2>/dev/null || echo "Tag already pushed"; \
 	if command -v gh > /dev/null; then \
 		gh release create "v$$VERSION" \
-			--title "CTD Tools v$$VERSION" \
+			--title "SeaSenseLib v$$VERSION" \
 			--notes "Release version $$VERSION" \
 			--draft \
-			dist/ctd_tools-$$VERSION.tar.gz \
-			dist/ctd_tools-$$VERSION-py3-none-any.whl; \
+			dist/seasenselib-$$VERSION.tar.gz \
+			dist/seasenselib-$$VERSION-py3-none-any.whl; \
 		echo "GitHub release created as draft. Please edit and publish manually."; \
 	else \
 		echo "GitHub CLI (gh) not found. Please create release manually at:"; \
-		echo "https://github.com/ocean-uhh/ctd-tools/releases/new"; \
+		echo "https://github.com/ocean-uhh/seasenselib/releases/new"; \
 		echo "Tag: v$$VERSION"; \
-		echo "Upload files: dist/ctd_tools-$$VERSION.tar.gz and dist/ctd_tools-$$VERSION-py3-none-any.whl"; \
+		echo "Upload files: dist/seasenselib-$$VERSION.tar.gz and dist/seasenselib-$$VERSION-py3-none-any.whl"; \
 	fi
 
 # ----------------------------------------

README.md

@@ -1,11 +1,11 @@
-# CTD Tools
+# SeaSenseLib
 
 A tool for reading, converting, and plotting sensor data from different oceanographic formats. 
 
 ## Table of Contents
 
 - [Installation](#installation)
-- [How to import CTD Tools](#how-to-import-ctd-tools)
+- [How to import SeaSenseLib](#how-to-import-seasenselib)
 - [CLI Usage](#cli-usage)
 - [Example data](#example-data)
   - [Converting a CNV file to netCDF](#converting-a-cnv-file-to-netcdf)
@@ -15,23 +15,23 @@ A tool for reading, converting, and plotting sensor data from different oceanogr
 
 ## Installation
 
-To install CTD Tools, we strongly recommend using a scientific Python distribution. 
-If you already have Python, you can install CTD Tools with:
+To install SeaSenseLib, we strongly recommend using a scientific Python distribution. 
+If you already have Python, you can install SeaSenseLib with:
 
 ```bash
-pip install ctd-tools
+pip install seasenselib
 ```
 
 Now you're ready to use the library.
 
-## How to import CTD Tools
+## How to import SeaSenseLib
 
-Example code for using the CTD Tools library in your project:
+Example code for using the SeaSenseLib library in your project:
 
 ```python
-from ctd_tools.readers import SbeCnvReader, NetCdfReader
-from ctd_tools.writers import NetCdfWriter
-from ctd_tools.plotters import TimeSeriesPlotter
+from seasenselib.readers import SbeCnvReader, NetCdfReader
+from seasenselib.writers import NetCdfWriter
+from seasenselib.plotters import TimeSeriesPlotter
 
 # Read CTD data from CNV file
 reader = SbeCnvReader("sea-practical-2023.cnv")
@@ -54,7 +54,7 @@ This chapter describes how to run the program from CLI.
 After installing as a Python package, you can run it via CLI by just using the package name: 
 
 ```bash
-ctd-tools
+seasenselib
 ```
 The various features of the tool can be executed by using different commands. To invoke a command, simply append 
 it as an argument to the program call via CLI (see following example section for some examples). The 
@@ -73,18 +73,18 @@ Every command uses different parameters. To get more information about how to us
 program and each command, just run it with the `--help` (or `-h`) argument:
 
 ```bash
-ctd-tools --help
+seasenselib --help
 ```
 
 To get help for a single command, add `--help` (or `-h`) argument after typing the command name:
 
 ```bash
-ctd-tools convert --help
+seasenselib convert --help
 ```
 
 ## Example data
 
-In the `examples` directory of the [code repository on GitLab](https://gitlab.rrz.uni-hamburg.de/ifmeo-sea-practical/ctd-tools) you'll find example Seabird CNV files from real research cruises.
+In the `examples` directory of the [code repository](https://github.com/ocean-uhh/seasenselib) you'll find example files from real research cruises.
 
 - The file `sea-practical-2023.cnv` contains data from a vertical CTD profile (one downcast) with parameters `temperature`, `salinity`, `pressure`, `oxygen`, `turbidity`.
 - The file `denmark-strait-ds-m1-17.cnv` contains data from an instrument moored over six days in a depth of around 650 m with parameters `temperature`, `salinity`, `pressure`.
@@ -96,7 +96,7 @@ The following examples will guide you through all available commands using the f
 Use the following command to convert a CNV file to a netCDF file:
 
 ```bash
-ctd-tools convert -i examples/sea-practical-2023.cnv -o output/sea-practical-2023.nc
+seasenselib convert -i examples/sea-practical-2023.cnv -o output/sea-practical-2023.nc
 ```
 
 As you can see, format detection works for this command via file extension (`.nc` for netCDF or `.csv` for CSV), but you can also specify it via argument `--format` (or `-f`).
@@ -105,15 +105,15 @@ Important note: Our example files work out of the box. But in some cases your Se
 are not known of our program or the `pycnv` library which we're using. If you get an error due to missing parameters while converting or if you miss parameters during further data processing, e.g. something essential like the temperature, then a parameter mapping might be necessary. A parameter mapping is performed with the argument `--mapping` (or `-m`), which is followed by a list of mapping pairs separated with spaces. A mapping pair consists of a standard parameter name that we use within the program and the corresponding name of the column or channel from the Seabird CNV file. Example for a mapping which works for the example above:
 
 ```bash
-ctd-tools convert -i examples/sea-practical-2023.cnv -o output/sea-practical-2023.nc -m temperature=tv290C pressure=prdM salinity=sal00 depth=depSM
+seasenselib convert -i examples/sea-practical-2023.cnv -o output/sea-practical-2023.nc -m temperature=tv290C pressure=prdM salinity=sal00 depth=depSM
 ```
 
 ### Showing the summary of a netCDF
 
 For the created netCDF file:
 
 ```bash
-ctd-tools show -i output/sea-practical-2023.nc
+seasenselib show -i output/sea-practical-2023.nc
 ```
 
 Again, format detection works also for this command via file extension (`.nc` for netCDF, `.csv` for CSV, `.cnv` for CNV).
@@ -123,19 +123,19 @@ Again, format detection works also for this command via file extension (`.nc` fo
 Plot a T-S diagram:
 
 ```bash
-ctd-tools plot-ts -i output/sea-practical-2023.nc
+seasenselib plot-ts -i output/sea-practical-2023.nc
 ```
 
 Plot a vertical CTD profile:
 
 ```bash
-ctd-tools plot-profile -i output/sea-practical-2023.nc
+seasenselib plot-profile -i output/sea-practical-2023.nc
 ```
 
 Plot a time series for 'temperature' parameter:
 
 ```bash
-ctd-tools plot-series -i output/sea-practical-2023.nc -p temperature salinity --dual-axis
+seasenselib plot-series -i output/sea-practical-2023.nc -p temperature salinity --dual-axis
 ```
 
 Also for this command, format detection works via file extension (`.nc` for netCDF, `.csv` for CSV, `.cnv` for CNV).
@@ -150,8 +150,8 @@ Start here to set up your local development environment: clone the repository, c
 1. **Clone the repo**  
 
    ```bash
-   git clone https://github.com/ocean-uhh/ctd-tools.git
-   cd ctd-tools
+   git clone https://github.com/ocean-uhh/seasenselib.git
+   cd seasenselib
    ```
 
 2. **Create and activate a virtual environment**
@@ -197,7 +197,7 @@ Useful commands:
 - **Execute the application**
 
   ```bash
-  python -m ctd_tools
+  python -m seasenselib
   ```
 
 - **Build distributions**

docs/source/about.rst

@@ -1,7 +1,7 @@
-About CTD Tools
+About SeaSenseLib
 ===============
 
-CTD Tools is a Python library for reading, converting, and plotting oceanographic sensor data from various instruments and formats. The package is designed to work seamlessly with data from moored instruments and CTD profiles, supporting multiple file formats commonly used in oceanographic research.
+SeaSenseLib is a Python library for reading, converting, and plotting oceanographic sensor data from various instruments and formats. The package is designed to work seamlessly with data from moored instruments and CTD profiles, supporting multiple file formats commonly used in oceanographic research.
 
 **Key Features:**
 
@@ -22,15 +22,15 @@ CTD Tools is a Python library for reading, converting, and plotting oceanographi
 
 **Project Goals:**
 
-CTD Tools aims to simplify the process of working with oceanographic sensor data by providing:
+SeaSenseLib aims to simplify the process of working with oceanographic sensor data by providing:
 
 1. **Standardized Data Access**: Convert proprietary formats to standard xarray Datasets
 2. **Consistent API**: Uniform interface across different instrument types
 3. **CF Convention Support**: Ensure output data follows Climate and Forecast metadata conventions
 4. **Research Reproducibility**: Enable easy sharing and reprocessing of oceanographic datasets
 5. **Educational Use**: Provide tools suitable for teaching oceanographic data analysis
 
-**Who Should Use CTD Tools:**
+**Who Should Use SeaSenseLib:**
 
 * Oceanographic researchers working with CTD and mooring data
 * Students learning oceanographic data analysis
@@ -39,4 +39,4 @@ CTD Tools aims to simplify the process of working with oceanographic sensor data
 
 **Community and Support:**
 
-CTD Tools is developed and maintained by the oceanographic community. We welcome contributions, bug reports, and feature requests through our GitHub repository.
+SeaSenseLib is developed and maintained by the oceanographic community. We welcome contributions, bug reports, and feature requests through our GitHub repository.

docs/source/conf.py

@@ -15,7 +15,7 @@
 year = datetime.datetime.now(tz=datetime.timezone.utc).date().year
 
 # General information about the project.
-project = 'ctd_tools'
+project = 'seasenselib'
 author = 'Yves Sorge'
 copyright = f"{year}, {author}"
 release = 'v0.0.0'