Contributor Guide

This guide is for people interested in sharing their modelling components for use in the framework.

• Development
  • Create your science component by subclassing a generic framework component
  • Document your science component using its class docstring
  • Define your science component using its class attributes
  • Implement the initialise-run-finalise component class methods
• Packaging
  • Create a local git repository
  • Retrieve the component package template
  • Bring in your component contribution(s)
  • Populate the package metadata
• Sharing
  • Push your contribution to the unifhy GitHub organisation
  • Upload your contribution to the Python Package Index