global19-atlassian-net / template-3

A template for code examples on this account. See for details on contribution guidelines.

Interested in contributing a code example?

Please take a look at our contribution guidelines before getting started. Thanks!

<demo_name>

Describe your example and specify what it is demonstrating. Consider the following questions:

• Is it pedagogical or a usable application?
• Does it belong to a particular domain such as material simulation or logistics?
• What level of Ocean proficiency does it target (beginner, advanced, pro)?

A clear description allows us to properly categorize your example.

Images are encouraged. If your example produces a visualization, consider displaying it here.

Usage

A simple command that runs your program. For example,

python <demo_name>.py

If your example requires user input, make sure to specify any input limitations.

Code Overview

A general overview of how the code works.

We prefer descriptions in bite-sized bullet points:

• Here's an example bullet point

Code Specifics

Notable parts of the code implementation.

This is the place to:

• Highlight a part of the code implementation
• Talk about unusual or potentially difficult parts of the code
• Explain a code decision
• Explain how parameters were tuned

Note: there is no need to repeat everything that is already well-documented in the code.

References

A. Person, "Title of Amazing Information", short link name

License

Released under the Apache License 2.0. See LICENSE file.