Skip to content

Home

Jump to bottom
jonathan-winn-geo edited this page Feb 8, 2023 · 9 revisions

Welcome to the cma-tools wiki!

This repo was created for TRAINING USE ONLY and is associated with the cmatools and cmascience repos

See the following page for a description of the purpose of this project:

A full description of the contents of this wiki is outlined here:

The current development plan - see overview repo

View the documentation here

Overview

Purpose and content

Wiki contents

User Guide

Installation and use

Developer's Guide

Setup for development

System tests

Test plan

Maintenance

Uninstall

GitHub plugins

PyCharm setup

Branch based development

Code review and Pull requests

Code quality and style

Workflows (Pipelines)

Creating a release

Template use

Template use

Project management

cmascience requirements

cmatools requirements

System architecture

GitHub setup and use

Python package development

Assumptions and context

Development environment

Package directory structure

Package structure examples

Package structure and testing

Naming conventions

Software versions

Version managment examples

Dataset versions

Command line tools

Testing

Test configuration

Running an application

Sphinx documentation setup

Documentation page layout

Sharing a package

Linking packages

Multi package repos

Appendix

Terminology

Config log

Decision log

Learning log

References

(Climate dataset repos)

(Package directory structure)

(Naming conventions)

(Testing)

Clone this wiki locally