Skip to main content

CTD and bottle data processing package from UCSD ODF

Project description

PyPI Latest Release PyPI Python Versions Package Status License Code style: black Imports: isort

GH Testing Documentation Status

ctdcal project

The ctdcal project is a library primarily designed to process data from CTD casts and calibrate them against Niskin bottle samples.

In the future, parts of the ctdcal library will be split off into additional packages, such as an "ocean sensors" package with Python implementations of conversion routines for in-situ sensors used for ocean measurement.


Installation

ctdcal can be installed using pip:

$ pip install ctdcal

CLI usage

Initialize data folders

Initialize default /data/ folders by running:

$ ctdcal init

(Future versions of ctdcal are planned have more robust init options/flags/etc.)

Import and process data

To process data, copy over raw .hex and .xmlcon files into /data/raw/ and reference data to their appropriate folder (oxygen, reft, salt).

Users can process their data with individual ctdcal functions or try:

$ ctdcal process [--group ODF]

to process using ODF procedures.


Package usage

Explore user settings

Most ctdcal functions get settings from user_settings.yaml and subsequently config.py. Call the configuration loader to explore default settings:

from ctdcal import get_ctdcal_config
cfg = get_ctdcal_config()

# directories for I/O purposes
print(cfg.dirs)
print(cfg.fig_dirs)

# experiment-specific settings (e.g., expocode, CTD serial number) from user_settings.yaml
print(cfg.settings)

# dictionary mapping of short/long column names
print(cfg.columns)

As ctdcal continues to be developed, more robust tutorials will be added to our documentation.


LICENSING

BSD 3-clause

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ctdcal-0.1.5b0.tar.gz (610.9 kB view details)

Uploaded Source

Built Distribution

ctdcal-0.1.5b0-py3-none-any.whl (121.4 kB view details)

Uploaded Python 3

File details

Details for the file ctdcal-0.1.5b0.tar.gz.

File metadata

  • Download URL: ctdcal-0.1.5b0.tar.gz
  • Upload date:
  • Size: 610.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for ctdcal-0.1.5b0.tar.gz
Algorithm Hash digest
SHA256 506acef1c453c459e1c3209fd637d5374a54e91ac800a4d26295d7daeae3ede8
MD5 d114f8187a58d8e7f609a6054ca7faf7
BLAKE2b-256 d798dc9708d29a0be8c88987f5d060f03ba2af7beeaa90c92dab9f6976ae11bb

See more details on using hashes here.

File details

Details for the file ctdcal-0.1.5b0-py3-none-any.whl.

File metadata

  • Download URL: ctdcal-0.1.5b0-py3-none-any.whl
  • Upload date:
  • Size: 121.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for ctdcal-0.1.5b0-py3-none-any.whl
Algorithm Hash digest
SHA256 9bbf9e4738211d4b8647ebb5e835b55d6e01c1baf64c10f310c1233298c82b72
MD5 d4c5ed2b3558da73a00327b6f2b5e0ef
BLAKE2b-256 f4d7ef14d7fddfe845a84689bd61cc1ba65765552bc478490083922b02daf006

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page