Metadata-Version: 2.1
Name: ngiab_data_preprocess
Version: 1.0.1
Summary: Graphical Tools for creating Next Gen Water model input data.
Author-email: Josh Cunningham <josh.cu@gmail.com>
Project-URL: Homepage, https://github.com/CIROH-UA/NGIAB_data_preprocess
Project-URL: Issues, https://github.com/CIROH-UA/NGIAB_data_preprocess/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: pyarrow ==15.0.2
Requires-Dist: PyYAML ==6.0.1
Requires-Dist: pyogrio ==0.7.2
Requires-Dist: pyproj ==3.6.1
Requires-Dist: Flask ==3.0.2
Requires-Dist: Flask-Cors ==4.0.0
Requires-Dist: geopandas ==0.14.3
Requires-Dist: requests ==2.32.2
Requires-Dist: igraph ==0.11.4
Requires-Dist: s3fs ==2024.3.1
Requires-Dist: xarray ==2024.2.0
Requires-Dist: rioxarray ==0.15.1
Requires-Dist: zarr ==2.17.1
Requires-Dist: netCDF4 ==1.6.5
Requires-Dist: dask ==2024.4.1
Requires-Dist: dask[distributed] ==2024.4.1
Requires-Dist: black ==24.3.0
Requires-Dist: isort ==5.13.2
Requires-Dist: h5netcdf ==1.3.0
Requires-Dist: numba ==0.59.1
Requires-Dist: exactextract ==0.2.0.dev0
Requires-Dist: numpy ==1.26.4
Requires-Dist: flaskwebgui ==1.1.0
Requires-Dist: tqdm ==4.66.4

This repository contains tools for preparing data to run a [next gen](https://github.com/NOAA-OWP/ngen) simulation using [NGIAB](https://github.com/CIROH-UA/NGIAB-CloudInfra). The tools allow you to select a catchment of interest on an interactive map, choose a date range, and prepare the data with just a few clicks!

![map screenshot](https://github.com/CIROH-UA/NGIAB_data_preprocess/blob/main/modules/map_app/static/resources/screenshot.png)


## What does this tool do?

This tool prepares data to run a next gen simulation by creating a run package that can be used with NGIAB. It picks default data sources, including the [v20.1 hydrofabric](https://www.lynker-spatial.com/data?path=hydrofabric%2Fv20.1%2F) and [nwm retrospective v3 forcing](https://noaa-nwm-retrospective-3-0-pds.s3.amazonaws.com/index.html#CONUS/zarr/forcing/) data.

## Requirements

* This tool is officially supported on macOS or Ubuntu. To use it on Windows, please install [WSL](https://learn.microsoft.com/en-us/windows/wsl/install).
* GDAL needs to be installed.
* The 'ogr2ogr' command needs to work in your terminal.

`sudo apt install gdal-bin` will install gdal and ogr2ogr on ubuntu / wsl

## Installation and running

```bash
#optional but encouraged: create a virtual environment
python3 -m venv env
source env/bin/activate

# installing and running the tool
pip install ngiab_data_preprocess
python -m map_app
```

The first time you run this command, it will download the hydrofabric and model parameter files from Lynker Spatial. If you already have them, place `conus.gpkg` and `model_attributes.parquet` into `modules/data_sources/`.

## Development Installation
<details>
  <summary>Installation steps</summary>
    To install and run the tool, follow these steps:

    1. Clone the repository:
        ```bash
        git clone https://github.com/CIROH-UA/NGIAB_data_preprocess
        cd NGIAB_data_preprocess
        ```

    2. Create a virtual environment and activate it:
        ```bash
        python3 -m venv env
        source env/bin/activate
        ```

    3. Install the tool:
        ```bash
        pip install -e .
        ```

    4. Run the map app:
        ```bash
        python -m map_app
        ```
</details>

## Usage

Running the command `python -m map_app` will open the app in a new browser tab. Alternatively, you can manually open it by going to [http://localhost:5000](http://localhost:5000) with the app running.

To use the tool:

1. Select the catchment you're interested in on the map.
2. Pick the time period you want to simulate.
3. Click the following buttons in order:
    1) Create subset gpkg
    2) Create Forcing from Zarrs
    3) Create Realization

Once all the steps are finished, you can run NGIAB on the folder shown underneath the subset button.

**Note:** When using the tool, the output will be stored in the `./output/<your-first-catchment>/` folder. There is no overwrite protection on the folders.
