Metadata-Version: 2.1
Name: download-toolbox
Version: 0.0.2
Summary: Library for downloading and preprocessing data
Author: British Antarctic Survey / Alan Turing Institute
Maintainer-email: jambyr@bas.ac.uk
License: MIT License
        
        Copyright (c) 2024, British Antarctic Survey
        
        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://icenet.ai/
Project-URL: Source, https://github.com/antarctica/download-toolbox
Project-URL: Issue tracker, https://github.com/antarctica/download-toolbox/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS.md
Requires-Dist: cdsapi
Requires-Dist: cfgrib
Requires-Dist: dask[distributed]
Requires-Dist: eccodes
Requires-Dist: ecmwf-api-client
Requires-Dist: esgf-pyclient
Requires-Dist: motuclient
Requires-Dist: orjson
Requires-Dist: pandas
Requires-Dist: pip
Requires-Dist: pydap
Requires-Dist: setuptools
Requires-Dist: wheel
Requires-Dist: urllib3<2.0.0
Requires-Dist: xarray[io]
Provides-Extra: dev
Requires-Dist: watchdog; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: tox; extra == "dev"
Requires-Dist: coverage; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: importlib_metadata; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Provides-Extra: docs
Requires-Dist: jinja2; extra == "docs"
Requires-Dist: Sphinx; extra == "docs"
Requires-Dist: myst_parser; extra == "docs"

# BAS Download Toolbox

![GitHub issues](https://img.shields.io/github/issues/antarctica/download-toolbox?style=plastic)
![GitHub closed issues](https://img.shields.io/github/issues-closed/antarctica/download-toolbox?style=plastic)
![GitHub](https://img.shields.io/github/license/antarctica/download-toolbox)
![GitHub forks](https://img.shields.io/github/forks/antarctica/download-toolbox?style=social)
![GitHub forks](https://img.shields.io/github/stars/antarctica/download-toolbox?style=social)

This is the core python library for the download toolbox utilities used by BAS 
data pipelines.

This is only just getting started, more info will appear soon.

Contact `jambyr <at> bas <dot> ac <dot> uk` if you want further information.

## Table of contents

* [Overview](#overview)
* [Installation](#installation)
* [Implementation](#implementation)
* [Contributing](#contributing)
* [Credits](#credits)
* [License](#license)

## Installation

Not currently released to pip.

Please refer to [the contribution guidelines for more information.](CONTRIBUTING.rst)

## Implementation

When installed, the library will provide a series of CLI commands. Please use 
the `--help` switch for more initial information, or the documentation. 

### Basic principles

The library sets up downloaders that will go through the following steps, 
for a variety of different data sources:

1. Set up a data store or if it exists, read the provenance config
2. Naively optimise the requested download
3. Download from the source in parallel
4. Transform the dataset into convenient to use files, ready for processing

That last step is important, as it might result in a different dataset to that which comes 
from source. The tool is intended to record this in the provenenace configuration, which is 
why it might exist in step (1), so that new data downloaded is consistent with what's 
there - as well as the differences from the source data recorded for consistency (you 
should not be able to screw up existing datasets), posterity and reproducibility. 

## Limitations

There are some major limitations to this as a general purpose tool, these will 
hopefully be dealt with in time! They likely don't have issues related, yet.

* Works only for hemisphere level downloading - north or south. The overhaul for this intends to ensure that identifiers are used so that someone can specify "north" or "south" but equally specify "Norway" or "The Shops" and then provide a geolocation that would identify the dataset within the filesystem.

**This is currently very heavy development functionality, but the following downloaders should work**: 

* download_amsr2
* download_cmip
* download_era5
* download_osisaf

Other stubs probably don't work, unless I forgot to update these docs!

## Contributing 

Please refer to [the contribution guidelines for more information.](CONTRIBUTING.rst)

## Credits

<a href="https://github.com/antarctica/download-toolbox/graphs/contributors"><img src="https://contrib.rocks/image?repo=antarctica/download-toolbox" /></a>

## License

This is licensed using the [MIT License](LICENSE)
