Skip to main content

# Preprocessing Toolbox

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

This is the preprocessing library for taking download-toolbox datasets and combining / composing multi-source data loaders that can be used to cache or supply downstream applications.

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.md)

## 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 provides the ability to preprocess download-toolbox datasets and create singular configurations for reading out the data in a multi-channel format for dataset construction:

1. Preprocess datasets from download-toolbox so that the dataset is continuous and normalised for the downstream application 1. Generate a loader configuration, applying additional metadata (arbitrary channels and masks) providing initial access to the collected data 1. Use this data loader to produce usable application datasets for downstream applications (testing with IceNet and another internal application)

This is a base library upon which application specific processing is based, lowering the implementation overhead for creating multi-source datasets for environmental applications that require integration of data from sources that download-toolbox provide.

This library doesn’t have knowledge of those datasets, it forms the basis for processing things specific to an application by importing application-specific logic dynamically. See [this issue](https://github.com/environmental-forecasting/preprocess-toolbox/issues/1) for a quick idea of how this works with the [IceNet workflow](https://github.com/icenet-ai/icenet).

## Limitations

There are some major limitations to this as a general purpose tool, these will hopefully be dealt with in time! I’m raising issues as I go

This is currently very heavy development functionality, but the following commands already work:

  • preprocess_missing_spatial - poorly at present due to missing mask backref implementation

  • preprocess_missing_time

  • preprocess_regrid

  • preprocess_rotate

  • preprocess_dataset

  • preprocess_loader_init

  • preprocess_add_mask

  • preprocess_add_channel

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

## Contributing

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

## Credits

<a href=”https://github.com/environmental-forecasting/preprocess-toolbox/graphs/contributors”><img src=”https://contrib.rocks/image?repo=environmental-forecasting/preprocess-toolbox” /></a>

## License

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

Metadata

Release files for preprocess-toolbox 0.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for preprocess-toolbox 0.0.4
File Size Uploaded
preprocess_toolbox-0.0.4.tar.gz 33.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for preprocess-toolbox 0.0.4
File Interpreter ABI Platform
preprocess_toolbox-0.0.4-py3-none-any.whl Python 3 none any Details

Total release size: 66.0 kB

Release files / preprocess_toolbox-0.0.4.tar.gz

Download URL preprocess_toolbox-0.0.4.tar.gz
Size 33.3 kB
Tags Source
SHA-256 checksum
How to use checksums
130192c11a8c43ff19085e68cd05c376ecbb7a350a8dd4f8a499244c1f2ba92d
BLAKE2b-256 checksum
How to use checksums
e233a06f0e92d56c12f41ce94050406ba15fc45f12947324ac71178a8285cef2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.8.18

Release files / preprocess_toolbox-0.0.4-py3-none-any.whl

Download URL preprocess_toolbox-0.0.4-py3-none-any.whl
Size 32.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4ab50c2417ab73a3047f7263139011b3c367986893582090696f1993ec031210
BLAKE2b-256 checksum
How to use checksums
3173ce031a3dcf433212ae12dde6a45f383d8901e06789169170edc92f4e597a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.8.18

Release history Release notifications | RSS feed

This release

0.0.4 This release

2 release files

0.0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page