Metadata-Version: 2.5
Name: kval
Version: 0.6.0
Summary: Processing and analysis of ocean data in Python
Project-URL: Homepage, https://github.com/NPIOcean/kval/
Author-email: Øyvind Foss <oyvind.foss@npolar.no>, Tore Hattermann <tore.hattermann@npolar.no>
Maintainer: Norwegian Polar Institute, Oceanography section
Maintainer-email: "Øyvind Foss, NPI" <oyvind.foss@npolar.no>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Oceanography
Requires-Python: <3.14,>=3.11
Requires-Dist: cartopy>=0.21.1
Requires-Dist: cftime>=1.6.2
Requires-Dist: cmocean>=3.0.3
Requires-Dist: compliance-checker>=6.1
Requires-Dist: gsw>=3.6
Requires-Dist: ipykernel<7,>=6.26.0
Requires-Dist: ipympl>=0.9.3
Requires-Dist: matplotlib<3.11,>=3.10
Requires-Dist: netcdf4>=1.6.4
Requires-Dist: numpy>=1.23
Requires-Dist: pandas>=2.2.0
Requires-Dist: pygeomag>=1.1.0
Requires-Dist: pyrsktools>=1.1.1
Requires-Dist: ruamel-yaml>=0.18.15
Requires-Dist: scipy>=1.11.3
Requires-Dist: tqdm>=4.66.1
Requires-Dist: xarray>=2023.10.1
Provides-Extra: dev
Requires-Dist: pytest>=8.1.1; extra == 'dev'
Requires-Dist: requests>=2.2.1; extra == 'dev'
Description-Content-Type: text/markdown

![image](https://raw.githubusercontent.com/npiocean/kval/master/graphics/kval_banner.png)

Collection of Python tools for working with oceanography data processing and analysis.

Maintained by the Oceanography section at the [Norwegian Polar Institute](https://www.npolar.no/en/) and supported by the [HiAOOS](https://hiaoos.eu/) project.
___


#### [Documentation page](https://kval.readthedocs.io/) *(in development)*


___

### Installation

Conda:

    conda install -c npiocean -c conda-forge kval


Pip [^tag] :

    pip install kval


[^tag]: Conda is recommended for Windows users as we have experienced errors with the dependent library `compliance-checker` on Windows+pip.


___

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10360162.svg)](https://doi.org/10.5281/zenodo.10360162)

About the latest release, `0.6.0`:


> ***NOTE*** 0.6 changes some behaviour and defaults. Results can differ slightly from 0.5. 

**New**
- Time averaging function now records what it did in a CF-compatible format (`TIME_bnds`, `cell_methods`), with optional sample counts, standard deviations and medians.
- `combine_datasets` works with calendar intervals; `dataset_size(ds)` shows how large a dataset is.

**Fixes**
- `.cnv` files could lose their first data row; SBE56 `.csv` dates could be read month-first - both fixed
- Fixes to RBR reading, despiking of 2-D data, `principal_angle`, `psd`, magnetic declination and ACDD metadata (`geospatial_bounds`), plus many smaller ones.

**Breaking changes**
- `drop_variables` takes `retain`/`drop` by name only.
- Daily averaging bins run midnight to midnight; `combine_datasets` keeps TIME in its input form.
- float64 is kept; int64 is written as int32.

**Dependencies**
- Requires `pandas>=2.2`; `glob2` and `xlrd` are no longer needed; `kval.util.era5` is removed.

`kval` is in active development.

___