Skip to content

nikothomas/ctdfjorder

Repository files navigation

DOI Tests badge PyPI version

CTDFjorder Logo

CTDFjorder is a Python package for processing and analyzing CTD (Conductivity, Temperature, Depth) data. Documentation: Read the docs

⭐ Features

  • Read RBR (.rsk) and SonTek Castaway (.csv) files and extract CTD data
  • Process CTD data, including removing non-positive samples and cleaning data
  • Calculate derived quantities such as absolute salinity, density, and potential density
  • Determine mixed layer depth (MLD) using different methods
  • Generate plots for visualizing CTD profiles and derived quantities
  • Command-line interface (CLI) for easy processing and merging of CTD data files

📦 Installation

It's recommended that you create a new environment just for CTDFjorder. This can be done in conda with the following command.

conda create --name ctdfjorder python=3.12
conda activate ctdfjorder

To install ctdfjorder you can use pip:

pip install ctdfjorder

🚀 Usage

CTDFjorder provides a command-line interface (CLI) for processing and analyzing CTD data in addition to serving as a python library. A tutorial has been setup here for running the CLI.

⚠️ Issues

If you encounter an issue while running or using CTDFjorder, please submit a report on the Issues page. This is the fastest way to get your problem resolved.

📝 License

CTDFjorder is released under the MIT License.

📑 Citing CTDFjorder

Citation information for CTDFjorder can be found here zenodo.13293665.

📢 Acknowledgments

CTDFjorder was developed for the Fjord Phyto project. The GSW-python library was used for certain dervied calculations.

Citations

McDougall, T. J., & Barker, P. M. (2011). Getting started with TEOS-10 and the Gibbs Seawater (GSW) Oceanographic Toolbox. SCOR/IAPSO WG127.

Pan, B.J.; Vernet, M.; Reynolds, R.A.; Mitchell, B.G.: The optical and biological properties of glacial meltwater in an Antarctic fjord. PLOS ONE 14(2): e0211107 (2019). https://doi.org/10.1371/journal.pone.0211107