coast-def

A model which simulates coastal flooding, and evaluated the economic benefits of climate adaptation strategies.

View the Project on GitHub zdb999/coast-def

Welcome to CoastDef

Our Values and Goals

CoastDef, short for Flood Defense, is a modeling tool that helps scientists, engineers, designeers, economists and engaged citizens analyze and plan for coastal flooding. It abstracts away as much of the programming details as possible, while giving users tools to make innovative, powerful models quickly.

CoastDef focuses on two questions. First, it aims to model where storm surges cause flooding using geospatial analysis. Secondly, it hopes to help us design sensible adaptation strategies by weighing the costs and benefits of flood control infrastructure.

As an open source project, CoastDef models are designed to be shared. The project is structured to invite experimentation and feedback. For more information about the project and how you can get involved, click on the link above.

Installation

These instructions focus on installing CoastDef on your local machine. It also discusses using Google Colab for projects, though the first tutorial goes into greater detail.

Tutorials

Our tutorials illustrate the core functionality of the CoastDef package. This is the best place to get started, and looking here first will make our more abstract documentation easier to understand. The tutorials illustrate the entire modeling pipeline, with a case study of Bridgeport, Connecticut. This is also a good place to copy initial code from when you’re starting a new project.

Example Uses of CoastDef

Want to learn about how other people are using CoastDef? This gallary contains examples of CoastDef in action. As the package gets more capable, we will add more examples here. We will also showcase research and design efforts that make use of CoastDef.

Finding Data Sources

What data do you need to use CoastDef, and why? How can you get it? This section provides an overview of the input data that CoastDef needs. Along the way, it gives a quick explanation of CoastDef’s algorithms. More in depth explanations are located in code comments and doc strings.

Modeling

This provides both academic justification for the choices we made in our standard sample model and advice for making your own models. We also discuss some of the weaknesses of our standard model.

API Syntax Documentation

Here are all of the details on CoastDef’s built in functions, methods, classes, and workflow. This area is under construction; for the moment, the tutorials are probably more reliable.