Metadata-Version: 2.1
Name: adcircpy
Version: 1.0.28
Summary: Python package for working with ADCIRC input and output files.
Home-page: https://github.com/jreniel/adcircpy.git
Author: Jaime R Calzada, Zach Burnett
Author-email: jreniel@gmail.com, zachary.burnett@noaa.gov
License: GPL
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: appdirs
Requires-Dist: bs4
Requires-Dist: eventlet
Requires-Dist: fiona
Requires-Dist: haversine
Requires-Dist: matplotlib
Requires-Dist: netCDF4
Requires-Dist: numpy
Requires-Dist: ordered-set
Requires-Dist: pandas
Requires-Dist: paramiko
Requires-Dist: psutil
Requires-Dist: pyproj (>=2.6)
Requires-Dist: geopandas
Requires-Dist: requests
Requires-Dist: scipy
Requires-Dist: seaborn
Requires-Dist: shapely
Requires-Dist: tropycal
Requires-Dist: utm
Requires-Dist: wget
Provides-Extra: development
Requires-Dist: colored-traceback ; extra == 'development'
Requires-Dist: coverage ; extra == 'development'
Requires-Dist: coverage-badge ; extra == 'development'
Requires-Dist: dunamai ; extra == 'development'
Requires-Dist: flake8 ; extra == 'development'
Requires-Dist: nose ; extra == 'development'
Requires-Dist: rednose ; extra == 'development'

# ADCIRCPy
## Python library for automating ADCIRC model runs.
[![tests](https://github.com/JaimeCalzadaNOAA/adcircpy/workflows/tests/badge.svg)](https://github.com/JaimeCalzadaNOAA/adcircpy/actions?query=workflow%3Atests)
[![build](https://github.com/JaimeCalzadaNOAA/adcircpy/workflows/build/badge.svg)](https://github.com/JaimeCalzadaNOAA/adcircpy/actions?query=workflow%3Abuild)
[![codecov](https://codecov.io/gh/JaimeCalzadaNOAA/adcircpy/branch/main/graph/badge.svg?token=BQWB1QKJ3Q)](https://codecov.io/gh/JaimeCalzadaNOAA/adcircpy)
[![version](https://img.shields.io/pypi/v/adcircpy)](https://pypi.org/project/adcircpy)
[![license](https://img.shields.io/github/license/JaimeCalzadaNOAA/adcircpy)](https://opensource.org/licenses/gpl-license)

### Installation notes:

Please use a virtual environment with Python>=3.6. You may use conda or the OS's Python to provide a virtual environment for the application.

You may install the application though pip. This will install the latest tagged version.
```bash
pip install adcircpy
```

Alternatively, you many manually install the repo by cloning it and then running
```bash
pip install .
```

### Examples: 
See the [examples](examples) directory for usage examples.


### Command Line:
This program exposes a few commands available from the command line interface. You may pass the `-h` flag to any of this commands to explore their functionality. 
* `tide_gen`
* `plot_mesh`
* `tidal_run`
* `best_track_run`
* `best_track_file`
* `plot_maxele`
* `plot_fort61` 
* `fort63`

#### Command line examples:

##### Generate tidal constituent template from command line
You can quickly create a tidal component table for your your mesh by executing the `tide_gen` command and by passing a mesh, a start date and number of run days as arguments.
This functions sources data from the [HAMTIDE](https://icdc.cen.uni-hamburg.de/en/hamtide.html) database by default.
```bash
tide_gen \
    /path/to/your/fort.14 \
    2021-02-26T00:00:00 \
    15 \
    --mesh-crs='epsg:4326'
```


##### Hurricane Sandy (AL182012)
To create the ADCIRC input files includes both tides and storm data for Hurricane Sandy:
```bash
best_track_run \
    /path/to/your/fort.14 \
    Sandy2012 \
    --fort13=/path/to/your/fort.13 \
    --crs=EPSG:4326 \
    --output-directory=/path/where/you/want/the/files \
    --constituents=all \
    --spinup-days=15.0 \
    --elev=30. \
    --mete=30. \
    --velo=30. \
    --skip-run
```
Note that the --crs flag is required due to the fort.14 not containing Coordinate Reference System information which is required for correct operation. [EPSG:4326](https://spatialreference.org/ref/epsg/wgs-84/) means that the mesh is in WGS84 (lat/lon).
Note that the backlash represents "continue on next line" for the shell. You may write the command above on a single line after excluding the backslashes.

##### Quick plots
These are two examples for doing quick plots with the package. These are given here as illustrative examples only. There is support for more file types than this examples, but the program does not yet support every output input/output file type.
As a user, you are encouraged to explore what's available and suggest and contribute your improvements.
```bash
plot_fort61 /path/to/fort.61.nc MSL --show --coops-only
```
```bash
plot_mesh /path/to/fort.14 --show-elements
```

### Contact
For questions comments and suggestions, please email me at jreniel@gmail.com


