oceanpack

Routines to handle log files of the OceanPack from SubCtech®

https://github.com/markusritschel/oceanpack

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.1%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Routines to handle log files of the OceanPack from SubCtech®

Basic Info
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 11
  • Releases: 0
Created almost 6 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog License Citation Authors

README.md

Oceanpack

build codecov License MIT license

Disclaimer: This is not an official package. The company SubCtech is not involved in the development of the routines provided here.

This repository contains routines for the evaluation of data from the OceanPack™ AUMS (Autonomous Underwater Measuring System) by SubCtech®.

The oceanpack module contains routines to read-in log files of the OceanPack as well as various helper functions to help with the data processing, e.g.

  • converting coordinates from the Analyzer's format into decimal digits
  • converting xCO2 to pCO2
  • applying temperature corrections
  • computing the fugacity fCO2
  • etc.

Installation

Clone this repo via

bash git clone https://github.com/markusritschel/oceanpack

Then, in the new directory (cd oceanpack/) install the package via:

bash pip install .

or via

bash pip install -e .

if you plan to make changes to the code.

Alternatively, install directly from GitHub via

bash pip install 'git+https://github.com/markusritschel/oceanpack.git'

Examples

In the subdirectory notebooks one can also find a Jupyter Notebook showing the usage of the various functions based on a short dataset.

Testing

Run make tests in the source directory to test the code. This will execute both the unit tests and docstring examples (using pytest).

Run make lint to check code style consistency.

Contact & Issues

For any questions or issues, please contact me via git@markusritschel.de or open an issue.


© Markus Ritschel 2024

Owner

  • Name: Markus Ritschel
  • Login: markusritschel
  • Kind: user
  • Location: Hamburg
  • Company: Doctoral candidate at the University of Hamburg and Max-Planck-Institute for Meteorology

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Ritschel"
  given-names: "Markus"
  orcid: "https://orcid.org/0000-0000-0000-0000"
title: "Oceanpack"
version: 0.1.0
doi: 10.5281/zenodo.1234
date-released: 2024-06-12
url: "https://github.com/markusritschel/oceanpack"

GitHub Events

Total
Last Year

Dependencies

requirements.txt pypi
  • numpy *
  • pandas *
  • tqdm *
.github/workflows/main.yml actions
  • JamesIves/github-pages-deploy-action v4 composite
  • actions/cache v1 composite
  • actions/checkout v3 composite
  • actions/download-artifact v2 composite
  • actions/setup-python v3 composite
  • actions/upload-artifact v2 composite
  • codecov/codecov-action v1 composite
docs/requirements.txt pypi
  • Sphinx *
  • furo *
  • jupyter-book *
  • jupytext *
  • myst-parser *
  • mystmd *
  • nbsphinx *
  • pydata-sphinx-theme *
  • rinohtype *
  • sphinx-autoapi *
  • sphinx-autodoc-defaultargs *
  • sphinx-autodoc-typehints *
  • sphinx-book-theme *
  • sphinx-immaterial *
  • sphinx-issues *
  • sphinx-material *
  • sphinx-rtd-theme *
  • sphinx-tabs *
  • sphinx-toolbox *
  • sphinxcontrib-apidoc *
  • sphinxcontrib-bibtex *
  • sphinxcontrib-htmlhelp *
  • sphinxcontrib-images *
  • sphinxcontrib-mermaid *
  • sphinxcontrib-napoleon *
  • sphinxcontrib-napoleon2 *
pyproject.toml pypi
environment.yml conda
  • click
  • colorama
  • deprecated
  • docopt
  • ipykernel
  • ipython
  • ipywidgets
  • jupyter-book
  • jupyterbook-latex
  • jupyterlab
  • jupyternotify
  • jupytext
  • markdown
  • matplotlib
  • mystmd
  • nodejs
  • numpy
  • pandas
  • pip
  • pytest
  • python-dotenv
  • tqdm
  • xarray