MITgcm Development HOWTO

Ed Hill III

<eh3@mit.edu>

Revision History
Revision 0.01	2003-08-07	Revised by: eh3
Initial version.
Revision 0.02	2010-01-21	Revised by: jmc
Update links.
Revision 0.03	2010-04-25	Revised by: jmc
Add subsection "Developer settings" (under CVS Repository).
Revision 0.04	2011-04-24	Revised by: jmc
Update subsection "The verification suite".

This document describes how to develop software for the MITgcm project.

Table of Contents

1. Introduction

1.1. New Versions of This Document
1.2. Feedback and corrections

2. Background

2.1. User Manual
2.2. Prerequisites

3. CVS Repository

3.1. Layout
3.2. Branches
3.3. Developer settings
3.4. Main code development

4. Coding for MITgcm

4.1. Build Tools

4.1.1. The genmake2 Utility
4.1.2. Using the Makefile

4.2. The Verification Suite

4.2.1. Test-experiment Directory Content
4.2.2. The testreport Utility
4.2.3. The do_tst_2+2 Utility

4.3. Creating MITgcm Packages

5. Chris's Notes...

6. Editing the Documentation

6.1. Getting the Docs and Code
6.2. Editing the Documentation
6.3. Building the Documentation

1. Introduction

The purpose of this document is to help new developers get "up to speed" with MITgcm development.

1.1. New Versions of This Document

You can obtain the latest version of this document online in various formats.

1.2. Feedback and corrections

If you have questions or comments about this document, please feel free to contact the authors.

		Next
		Background