Metadata-Version: 2.1
Name: bluemath-tk
Version: 1.0.1
Summary: Module collection for custom climate data analysis. The main objective of this Python package is to provide a set of statistical tools tailored for climate data analysis, with a focus on statistical classification and prediction.
Author-email: Geomatics and Ocean Engineering Group <bluemath@unican.es>
License: Copyright (c) 2024 GeoOcean group, Universidad de Cantabria
        
        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: Homepage, https://github.com/GeoOcean/BlueMath_tk
Project-URL: Documentation, https://geoocean.github.io/BlueMath_tk/
Project-URL: Issues, https://github.com/GeoOcean/BlueMath_tk/issues
Keywords: climate,statistical,tools
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: xarray
Requires-Dist: netcdf4
Requires-Dist: dask
Requires-Dist: zarr
Requires-Dist: scipy
Requires-Dist: scikit-learn
Requires-Dist: matplotlib
Requires-Dist: plotly
Requires-Dist: cartopy
Requires-Dist: cdsapi
Requires-Dist: jinja2
Requires-Dist: requests
Requires-Dist: aiohttp
Requires-Dist: minisom
Provides-Extra: docs
Requires-Dist: mkdocs; extra == "docs"
Requires-Dist: mkdocs-material; extra == "docs"
Requires-Dist: mkdocstrings; extra == "docs"
Requires-Dist: mkdocstrings[python]; extra == "docs"
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-mock; extra == "tests"
Provides-Extra: deep
Requires-Dist: tensorflow; extra == "deep"
Requires-Dist: keras; extra == "deep"

# Bluemath {**Toolkit**}

Module collection for custom climate data analysis. The main objective of this Python package is to provide a set of statistical tools tailored for climate data analysis, with a focus on statistical classification and prediction.

The package also includes a set of utility functions for processing climate data. To facilitate understanding of how to use these modules, simple demonstration scripts and the necessary data have been added to this repository.

## Main contents

![Sketch](./docs/sketch_tk.png)

Link to the different sections:
- [datamining](./bluemath_tk/datamining/)
- [waves](./bluemath_tk/waves/)
- [predictor](./bluemath_tk/predictor/)
- [TC](./bluemath_tk/tc/)
- [distributions](./bluemath_tk/distributions/)
- [wrappers](./bluemath_tk/wrappers/)
- [risk](./bluemath_tk/risk/)
- [tide](./bluemath_tk/tide/)

## Demos

In this repository, simple demo files showcasing the utilization of the different tools can be found in this [link](./demos). Furthermore, full examples with figures can be found in the [Bluemath - notebooks](./) repository.

## Authors

Codes have been developed through a collaborative effort by members of the GeoOcean group at the University of Cantabria. For inquiries, please contact Fernando Méndez at mendezf@unican.es

## License

This project is licensed under the MIT License. See the [license](LICENSE.txt) file for details

## Project status

- UNDER DEVELOPMENT

# TODOs

- Check whole code in NNs
- Check climate scale data in SamoaTonga
- Add logs to datamining classes.
- Descomentar crontab, que ya funcionan los sh
- Add ERA5 spectra download.
- Add docker, sbatch, et options in wrappers!
