Metadata-Version: 2.4
Name: oceanarray
Version: 0.2.0
Summary: Multi-stage processing pipeline for moored oceanographic observations: raw instrument files to QC-flagged CF-compliant NetCDF with automated HTML reports.
Maintainer-email: Eleanor Frajka-Williams <eleanorfrajka@gmail.com>
License: MIT License
        
        Copyright (c) 2025 Eleanor Frajka-Williams
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Documentation, https://ocean-uhh.github.io/oceanarray
Project-URL: Homepage, https://github.com/ocean-uhh/oceanarray
Project-URL: Repository, https://github.com/ocean-uhh/oceanarray
Project-URL: Issue Tracker, https://github.com/ocean-uhh/oceanarray/issues
Keywords: oceanography,mooring,ADCP,CTD,NetCDF,QC,oceanographic-data,AMOC
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Oceanography
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.23
Requires-Dist: pandas>=2.0
Requires-Dist: xarray>=2023.12.0
Requires-Dist: netcdf4>=1.6
Requires-Dist: scipy>=1.10
Requires-Dist: matplotlib>=3.7
Requires-Dist: gsw>=3.6.16
Requires-Dist: ppigrf
Requires-Dist: ioos_qc
Requires-Dist: dolfyn
Requires-Dist: pycwt
Requires-Dist: jinja2>=3.0
Requires-Dist: packaging>=21.0
Requires-Dist: ruamel.yaml>=0.18
Dynamic: license-file

# OceanArray

Python tools for processing moored oceanographic array observations from raw instrument files to quality-controlled, CF-compliant NetCDF.

**Documentation**: https://ocean-uhh.github.io/oceanarray/

## Installation

```bash
pip install oceanarray
```

`seasenselib` is required for reading raw instrument files (available on PyPI but needs `--no-deps`):

```bash
pip install pyrsktools pycnv
pip install seasenselib --no-deps
```

Python 3.9–3.12 is supported.

## Quick start

Create a skeleton YAML, fill in the deployment metadata, then process:

```bash
oceanarray init dsG3_1_2026 --proc-dir /data/proc
# edit /data/proc/dsG3_1_2026/dsG3_1_2026.mooring.yaml
oceanarray validate /data/proc/dsG3_1_2026/dsG3_1_2026.mooring.yaml
oceanarray process dsG3_1_2026 --raw-dir /data/raw --proc-dir /data/proc --stage 1 2 3 stack grid
oceanarray report  dsG3_1_2026 --raw-dir /data/raw --proc-dir /data/proc --all
```

See the [documentation](https://ocean-uhh.github.io/oceanarray/) for the recommended first-processing workflow, YAML reference, and CLI reference.

## Python API

```python
import oceanarray

oceanarray.process('dsG3_1_2026', raw_dir='/data/raw', proc_dir='/data/proc')
```

See the [API reference](https://ocean-uhh.github.io/oceanarray/oceanarray.html) for the full interface.

## License

MIT License
