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

Uploaded Source

Built Distribution

ctdcal-0.1.3b0-py3-none-any.whl (104.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ctdcal-0.1.3b0.tar.gz
  • Upload date:
  • Size: 98.0 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.3b0.tar.gz
Algorithm Hash digest
SHA256 e07bcb1ace447c2f0c6a17c9f16dac11a52c4aa1258dab4c8327b451adaa356f
MD5 0c67db3b12008d44af00f8ef817231ac
BLAKE2b-256 f8b4cbeeddfc184846d5b9bb6ed3a70eff9049d52b031a2653477f12620e04f9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ctdcal-0.1.3b0-py3-none-any.whl
  • Upload date:
  • Size: 104.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.3b0-py3-none-any.whl
Algorithm Hash digest
SHA256 3b86db2fbb6fd9ece4a852a7593878ffe6aa0c7f404737099ff96a62eb7ef7eb
MD5 f9f35bf55506150de38320e4a276fb0d
BLAKE2b-256 9d5520bc4e5c4118077a9e0362615dfdc36792dd2c3c868bd6a68a46303c0e05

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