Metadata-Version: 2.4
Name: fetchAZA
Version: 0.0.2a3.dev0
Summary: Repository to load data from Sonardyne Fetch AZA
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://github.com/eleanorfrajka/fetchAZA
Project-URL: homepage, https://github.com/eleanorfrajka/fetchAZA
Project-URL: repository, https://github.com/eleanorfrajka/fetchAZA
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
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.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: netcdf4
Requires-Dist: xarray
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: scipy
Dynamic: license-file

# fetchAZA

Repository for reading pressure data from the [Sonardyne Fetch AZA](https://www.sonardyne.com/product/fetch-aza-2/) into netCDF (xarray) format.


During the reading of files, there is an intermediate step where logging event lines in the `*.csv` data file are separated into individual netCDF files.  In the processing step, the hourly data are combined into a single netCDF file (comprising PIES, DQZ, KLR, etc events, into `*use.nc`) and the AZA sequence events that fit a valid sequence of AZS-AZA-AZA-AZA-AZS patterns are merged into a second netCDF file (`*AZAseq.nc*`)

This is a work in progress as part of the [EPOC](http://epoc-eu.org) project.

## Install

Install from PyPI with

```
python -m pip install fetchAZA
```

## Documentation

For documentation, see http://eleanorfrajka.github.io/fetchAZA.

Check out the demo notebook `notebooks/demo.ipynb` for example functionality.

As input, fetchAZA takes Sonardyne Fetch AZA `*.csv` files.  See [8318-FS Issue06.pdf](https://github.com/eleanorfrajka/fetchAZA/blob/main/docs/source/_static/8318-FS%20Issue06.pdf) for details of the data format, or check out the snippet in `data/sample_data.csv`.

## Contributing

Contributions welcome!  

To install a local, development version of fetchAZA, clone the repo, open a terminal in the root directory (next to this README.md file) and run these commands:

```
git clone https://github.com/eleanorfrajka/fetchAZA.git
cd fetchAZA
pip install -r requirements-dev.txt
pip install -e .
```

This installs fetchAZA locally.  `-e` ensures that any edits you make in the files will be picked up by scripts that import functions from fetchAZA.  You can run the example jupyter notebook by launching jupyterlab with `jupyter-lab` and navigating to the `notebooks` directory.

All new functions should include tests.  You can run the tests locally and generate a coverage report with:
```
pytest --cov=fetchAZA --cov-report term-missing tests/
```

