[](https://pypi.org/project/ctdcal/)
[](https://pypi.org/project/ctdcal/)
[](https://pypi.org/project/ctdcal/)
[](https://github.com/cchdo/ctdcal/blob/master/LICENSE.md)
[](https://github.com/ambv/black)
[](https://pycqa.github.io/isort/)
[](https://ctdcal.readthedocs.io/en/latest/?badge=latest)
# ctdcal project
The ctdcal project is a library primarily designed to process data from CTD casts and calibrate
them against Niskin bottle samples. This project is currently a work in progress and not yet
in public production.
A final public release is planned for 2025.
To contribute or try using ctdcal for yourself, feel free to install it and reach a member of the [SIO-ODF group](https://github.com/orgs/SIO-ODF/people)!
---
## 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:
```py
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](https://ctdcal.readthedocs.io/en/latest/tutorials.html) will be added to [our documentation](https://ctdcal.readthedocs.io/en/latest/).
---
## LICENSING
BSD 3-clause
Raw data
{
"_id": null,
"home_page": "https://github.com/SIO-ODF/ctdcal",
"name": "ctdcal",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "oceanography, seawater, TEOS-10, ctd, calibration",
"author": "\"Joseph Gum, Andrew Barna, Michael Kovatch, Aaron Mau, Allen Smith\"",
"author_email": "ajmau@ucsd.edu",
"download_url": "https://files.pythonhosted.org/packages/a8/23/f956ca4411e3f63c5ae1d6ca7324e4b4d3cfff8cba40dcfd830e616f79d2/ctdcal-0.1.5b1.dev0.tar.gz",
"platform": "any",
"description": "[](https://pypi.org/project/ctdcal/)\n[](https://pypi.org/project/ctdcal/)\n[](https://pypi.org/project/ctdcal/)\n[](https://github.com/cchdo/ctdcal/blob/master/LICENSE.md)\n[](https://github.com/ambv/black)\n[](https://pycqa.github.io/isort/)\n\n\n\n[](https://ctdcal.readthedocs.io/en/latest/?badge=latest)\n\n# ctdcal project\n\nThe ctdcal project is a library primarily designed to process data from CTD casts and calibrate\nthem against Niskin bottle samples. This project is currently a work in progress and not yet\nin public production.\n\nA final public release is planned for 2025.\n\nTo contribute or try using ctdcal for yourself, feel free to install it and reach a member of the [SIO-ODF group](https://github.com/orgs/SIO-ODF/people)!\n\n---\n\n## Installation\nctdcal can be installed using pip:\n\n```\n$ pip install ctdcal\n```\n\n---\n\n## CLI usage\n### Initialize data folders\nInitialize default `/data/` folders by running:\n\n```\n$ ctdcal init\n```\n\n(Future versions of ctdcal are planned have more robust init options/flags/etc.)\n\n### Import and process data\nTo process data, copy over raw `.hex` and `.xmlcon` files into `/data/raw/` and reference data to their appropriate folder (`oxygen`, `reft`, `salt`).\n\nUsers can process their data with individual ctdcal functions or try:\n\n```\n$ ctdcal process [--group ODF]\n```\n\nto process using ODF procedures.\n\n---\n\n## Package usage\n### Explore user settings\nMost ctdcal functions get settings from `user_settings.yaml` and subsequently `config.py`. Call the configuration loader to explore default settings:\n\n```py\nfrom ctdcal import get_ctdcal_config\ncfg = get_ctdcal_config()\n\n# directories for I/O purposes\nprint(cfg.dirs)\nprint(cfg.fig_dirs)\n\n# experiment-specific settings (e.g., expocode, CTD serial number) from user_settings.yaml\nprint(cfg.settings)\n\n# dictionary mapping of short/long column names\nprint(cfg.columns)\n```\n\nAs ctdcal continues to be developed, more robust [tutorials](https://ctdcal.readthedocs.io/en/latest/tutorials.html) will be added to [our documentation](https://ctdcal.readthedocs.io/en/latest/).\n\n---\n\n## LICENSING\nBSD 3-clause\n",
"bugtrack_url": null,
"license": null,
"summary": "CTD and bottle data processing package from UCSD ODF",
"version": "0.1.5b1.dev0",
"project_urls": {
"Homepage": "https://github.com/SIO-ODF/ctdcal"
},
"split_keywords": [
"oceanography",
" seawater",
" teos-10",
" ctd",
" calibration"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2d5d9dfba8347f555e9d4f198e851d491fbf5cfd0faf16c97ca943e112e8d083",
"md5": "1d930e44039d41a524e85618801ad6be",
"sha256": "ce04c2584a65d4722502f72b388674e4565cdd8f12a0493b55a042730870b41e"
},
"downloads": -1,
"filename": "ctdcal-0.1.5b1.dev0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1d930e44039d41a524e85618801ad6be",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 120920,
"upload_time": "2024-09-12T18:56:26",
"upload_time_iso_8601": "2024-09-12T18:56:26.314297Z",
"url": "https://files.pythonhosted.org/packages/2d/5d/9dfba8347f555e9d4f198e851d491fbf5cfd0faf16c97ca943e112e8d083/ctdcal-0.1.5b1.dev0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a823f956ca4411e3f63c5ae1d6ca7324e4b4d3cfff8cba40dcfd830e616f79d2",
"md5": "8fb54befecd11ace3cc36ac5f9c8e5b8",
"sha256": "86d6fc9fc15bbc69efc4cb81f9887562dca660c2bb60b12b9f4a211571d98fb0"
},
"downloads": -1,
"filename": "ctdcal-0.1.5b1.dev0.tar.gz",
"has_sig": false,
"md5_digest": "8fb54befecd11ace3cc36ac5f9c8e5b8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 611506,
"upload_time": "2024-09-12T18:56:27",
"upload_time_iso_8601": "2024-09-12T18:56:27.620373Z",
"url": "https://files.pythonhosted.org/packages/a8/23/f956ca4411e3f63c5ae1d6ca7324e4b4d3cfff8cba40dcfd830e616f79d2/ctdcal-0.1.5b1.dev0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-12 18:56:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SIO-ODF",
"github_project": "ctdcal",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ctdcal"
}
JSON
