adcircpy 1.0.1

Python package for working with ADCIRC input and output files.

AdcircPy

Installation notes:

Please use a virtual environment with >=Python3.6. You may use conda or the OS's Python to provide a virtual environment for the application. This is usually developed using the latest Python, but it should work with Python version >=3.6.

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

pip install adcircpy

Alternatively, you many manually install the repo by cloning it and then running

pip install .

See the examples directory for usage examples.

Additional Notes:

In order to be able to generate the tidal boundary conditions for the model, the TPXO^[1] file (h_tpxo9.v1.nc) needs to be available in the system. This file can be obtained by following the registration found here. Once you obtained the h_tpxo9.v1.nc file, you may execute

tpxo_install /path/to/your/h_tpxo9.v1.nc

This will stage the file in the installation directory for AdcircPy. In the future, the requirement for this proprietary file will be dropped in favor of an open source variant.

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.

• plot_mesh
• tidal_run
• best_track_run
• best_track_file
• plot_maxele
• plot_fort61
• plot_fort63

Command line examples:

Hurricane Sandy (AL182012)

To create the ADCIRC input files includes both tides and storm data for Hurricane Sandy (AL182012):

best_track_run \
    /path/to/your/fort.14 \
    AL182012 \
    --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 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.

plot_fort61 /path/to/fort.61.nc MSL --show --coops-only

plot_mesh /path/to/fort.14 --show-elements

Contact

For questions comments and suggestions, please email me at [e-mail]

References

[1] Egbert, Gary D., and Svetlana Y. Erofeeva. "Efficient inverse modeling of barotropic ocean tides." Journal of Atmospheric and Oceanic Technology 19.2 (2002): 183-204. https://www.tpxo.net/