Developer Guide

Welcome! If you want to understand, modify, or extend CrocoDash, start here.

Start with the architecture

The Architecture page covers how the modules fit together, which registries CrocoDash exposes, where to add new things, and how to run the tests. Read that first if you’re new to the codebase.

Extension guides

CrocoDash is designed to be extended without touching core code. Two common extension points have dedicated guides:

• Adding a forcing configuration — a new configurator for tides, BGC, rivers, salt restoring, etc.

• Adding a data source — a new raw dataset in raw_data_access/.

Reference

• Submodule API usage — every function CrocoDash calls from regional-mom6, mom6_forge, and visualCaseGen. Keep this handy when upstreams change.

• Writing documentation — how to build and contribute to these docs.

• Architecture
• Adding Data to the Data Access Module
• Adding Forcing Configurations
• Submodule API Usage
• Write Documentation
• Semi-Official ChangeLog

Project links

• GitHub Repository

• Issues

• Pull Requests

• CROCODILE Project

Questions?

• Search existing GitHub Discussions

• Open a new discussion for questions