ADCIRC

A system of computer programs for solving time-dependent, free-surface circulation and transport problems in two and three dimensions in applications such as storm surge and flood prediction.
https://github.com/adcirc/adcirc

Category: Climate Change
Sub Category: Natural Hazard and Storm

Keywords from Contributors

adcirc coastal-modelling geophysics meshes multiscale-simulation shallow-water-equations cyclones tropical noaa crms

Last synced: about 21 hours ago
JSON representation

Repository metadata

ADCIRC Model Repository

README.md

ADCIRC

CircleCI
License: LGPL v3
Docker Image Version (tag)
Documentation

ADCIRC is a system of computer programs for solving time dependent, free surface circulation and transport problems in
two and three dimensions. These programs utilize the finite element method in space allowing the use of highly flexible,
unstructured grids. Typical ADCIRC applications have included:

  • Prediction of storm surge and flooding
  • Modeling tides and wind driven circulation
  • Larval transport studies
  • Near shore marine operations
  • Dredging feasibility and material disposal studies

ADCIRC has been used around the world for various studies, including those conducted by the United States Army Corps of
Engineers (USACE), Federal Emergency Management Agency (FEMA), National Oceanographic and Atmospheric Administration
(NOAA), and many others.

Authors

  • Joannes Westerink, University of Notre Dame
  • Rick Luettich, University of North Carolina at Chapel Hill

Development Group

  • Brian Blanton - RENCI
  • Shintaro Bunya - University of North Carolina at Chapel Hill
  • Zachary Cobell - The Water Institute of the Gulf
  • Clint Dawson - University of Texas at Austin
  • Casey Dietrich - North Carolina State University
  • Randall Kolar - University of Oklahoma at Norman
  • Chris Massey - US Army Corps of Engineers Research and Development Center, Coastal and Hydraulics Laboratory

Gallery

Louisiana ADCIRC model simulating Hurricane Katrina storm surge and waves developed by The Water Institute of the Gulf.

ADCIRC mesh in the Chesapeake Bay area used for the FEMA Coastal Storm Surge Study

Versions

Code versions are published based on semantic versioning as of version 56. Prior to that, ADCIRC used a two level
versioning scheme, though it approximately mirrors semantic versioning.

Documentation

Documentation is presently undergoing upgrades, however, the main documentation locations for users are:

  1. ADCIRC documentation
  2. ADCIRC website
  3. ADCIRC Wiki

Contributors are actively consolidating information from ADCIRC website and ADCIRC Wiki into ADCIRC documentation to provide comprehensive, up-to-date information about ADCIRC.

Contributing

ADCIRC is an open source project and contributions are welcome.
Please see the CONTRIBUTING.md file for more information
on how to contribute to the project.

The high-level summary is:

  1. Run pre-commit install to install pre-commit hooks in your development environment. Pre-commit can be installed using pip install pre-commit.
  2. New source files should have a "*.F90" extension
  3. All new code should contain Doxygen-style comments
  4. Developers are encouraged to compile their code using the GCC compilers (even if this is not their typical development environment) with -DADCIRC_DEVELOPER_MODE=ON to ensure that the code will build in the CI environment with strict checks
  5. Developers should avoid adding new variables to the GLOBAL module unless absolutely necessary

Requirements

ADCIRC minimally requires a C and Fortran compiler that minimally meet the following specifications:

  • C compiler: C11 standard
  • Fortran compiler: Fortran 2008 standard

ADCIRC has been tested with the following compilers:

  • GNU Compiler Collection (GCC)
  • Intel Classic Compilers
  • Intel OneAPI Compilers/IntelLLVM
  • NVIDIA HPC Compilers (nvc/nvfortran)
  • LLVM (clang/flang)

Additional features, including MPI parallelism and netCDF output require additional libraries:

  • MPI (Message Passing Interface) - OpenMPI, MVAPICH2, Intel MPI, or other MPI implementations
  • netCDF - netCDF C and Fortran libraries

Docker Containers

To help new users get spun up quickly with the ADCIRC model, ADCIRC is provided as Linux Docker containers and pushed to DockerHub.
New images are published either when a new version is released or the main branch has changes. The DockerHub repository is
located here. Images may be used with Docker Desktop or Singularity on x86 or ARM CPUs
on Windows, Mac, and Linux.

Images are tagged for release versions (using semantic versioning) as well as the current state of the main branch as "latest".
By default, a release tag should be used and only use latest to try the newest version of the code. The ADCIRC Docker images are
distributed under the same license and conditions as this repository.

Images built for x86 systems use the IntelLLVM compiler while images build for ARM CPUs use the GCC compiler, version 14.2. The
x86 base image is the same that is used to build ADCIRC during continuous integration testing.

Examples

The ADCIRC testing repository doubles as a set of examples which can be used
for new users to become acquainted with the model. Since version 55, the branches are annotated with the expected
version numbers that would allow the tests to run successfully.


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 1 day ago

Total Commits: 992
Total Committers: 47
Avg Commits per committer: 21.106
Development Distribution Score (DDS): 0.725

Commits in past year: 80
Committers in past year: 10
Avg Commits per committer in past year: 8.0
Development Distribution Score (DDS) in past year: 0.325

Name Email Commits
Jason Fleming j****g@s****m 273
Zach Cobell z****l@g****m 243
Chris Massey C****y@u****l 76
Zach Cobell z****l@a****m 68
Zach Cobell z****l@a****m 51
WPringle w****e@n****u 45
Robert Weaver r****r@f****u 31
Casey Dietrich c****h@g****m 29
Dylan Wood d****d@g****m 21
Shintaro Bunya s****a@u****u 14
Damrongsak Wirasaet d****e@g****m 14
Christina Forbes c****s@n****v 13
Tristan a****r@n****u 13
T t****r 12
Shintaro Bunya s****a@g****m 11
Panagiotis Velissariou p****u@n****v 10
cblakely c****y@n****u 8
Corbitt Kerr p****r@n****u 6
Kendra Dresback d****k@o****u 5
caseydietrich d****h@i****u 4
tampbell t****l@n****m 4
Alper Altuntas a****s@g****m 3
Brian Blanton b****n@r****g 3
Seizo Tanaka t****o@g****m 3
Guoming Ling g****g@n****u 3
Aman Tejaswi a****i@a****u 3
Joel Dietrich j****1@l****u 2
William Pringle w****e@b****v 2
Youcan Feng y****g@g****m 2
Johnathan Woodruff j****6@g****m 2
and 17 more...

Committer domains:


Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 156
Total pull requests: 195
Average time to close issues: 12 months
Average time to close pull requests: about 1 month
Total issue authors: 33
Total pull request authors: 23
Average comments per issue: 2.5
Average comments per pull request: 0.85
Merged pull request: 163
Bot issues: 0
Bot pull requests: 0

Past year issues: 20
Past year pull requests: 41
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 10 days
Past year issue authors: 15
Past year pull request authors: 9
Past year average comments per issue: 2.0
Past year average comments per pull request: 0.76
Past year merged pull request: 37
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/adcirc/adcirc

Top Issue Authors

  • zcobell (45)
  • jasonfleming (41)
  • krober10nd (8)
  • tgasher (8)
  • wwlwpd (6)
  • WPringle (4)
  • mattbilskie (4)
  • ps2epsi (3)
  • shin-ozaki (2)
  • arashfathi (2)
  • cfulcherunc (2)
  • brian-jupiter (2)
  • XinghanLiu2002 (2)
  • samiiali (2)
  • caseydietrich (2)

Top Pull Request Authors

  • zcobell (100)
  • jasonfleming (24)
  • cblakely97 (15)
  • shinbunya (12)
  • poseidonND (4)
  • pvelissariou1 (4)
  • dwirasae (4)
  • jlwoodr (4)
  • caseydietrich (4)
  • krober10nd (4)
  • acrosby (3)
  • alperaltuntas (2)
  • mattbilskie (2)
  • dylnwood (2)
  • dave-gso (2)

Top Issue Labels

  • bug (67)
  • enhancement (60)
  • help wanted (11)
  • question (10)
  • critical (7)
  • bug-thirdparty (5)
  • duplicate (3)
  • wontfix (1)
  • feature-request (1)
  • invalid (1)

Top Pull Request Labels

  • bug (51)
  • enhancement (47)
  • bug-thirdparty (7)
  • maintenance (7)
  • critical (4)
  • documentation (2)

Package metadata

proxy.golang.org: github.com/adcirc/adcirc

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/adcirc/adcirc#section-documentation
  • Licenses: other
  • Latest release: v56.0.4+incompatible (published about 1 month ago)
  • Last Synced: 2025-06-26T01:02:55.338Z (2 days ago)
  • Versions: 12
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent packages count: 5.401%
    • Average: 5.583%
    • Dependent repos count: 5.764%

Score: -Infinity