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

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.2b0.tar.gz (101.7 kB view details)

Uploaded Source

Built Distribution

ctdcal-0.1.2b0-py3-none-any.whl (101.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ctdcal-0.1.2b0.tar.gz
  • Upload date:
  • Size: 101.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for ctdcal-0.1.2b0.tar.gz
Algorithm Hash digest
SHA256 5a4effc094f968223b40bbf80ab56d30d1a1fe494ed8b75c7877c79611e0345b
MD5 e283fb130384907db609df1ce410a62b
BLAKE2b-256 bdc35a61b44bbd4de029306a3f83930c677998985875e8e3706a8c382e6b9ca8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ctdcal-0.1.2b0-py3-none-any.whl
  • Upload date:
  • Size: 101.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for ctdcal-0.1.2b0-py3-none-any.whl
Algorithm Hash digest
SHA256 c1970ab23eb311202f6bc7c1e44d58c7773e755c30c776bc5bc050950647e832
MD5 920bf045ca4aabd5458bdc6e720f669c
BLAKE2b-256 38a3ce55e57206e4bf9c07c21dc6de495d6476674cc6d1e44149ea675fae9c1e

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