cmascience requirements - cma-open/cmatools GitHub Wiki

See overview repo wiki for generic guidance

• https://github.com/cma-open/overview/wiki/Software-requirements-(generic)

This page defines and details the project software requirements for the "cmascience" python package

It is very important to set early development goals that result in a working and testable system as soon as possible in the development cycle.

Software purpose

Aim 1:

• A command line tool to list the current range of datasets available via hadobs (static list)

Aim 2:

• A command line tool to create a simple climate datasets.
• This will initially be based on the basic data creation tool in cmatools, but will be expanded to hold additional processing steps and use of metadata

Aim 3:

• A command line tool to list the current, up to date, citation counts for each main reference paper for the list of available datasets via hadobs

Aim 4:

• A command line tool to list the current range of datasets available via hadobs (dynamic, scrape from website)

Software use and user inputs

• Software to be run via command line calls, via linux

User level

• The system is designed for an novice level user of climate data
• The user will be expected to be intermediate linux user

Non-functional requirements

• User friendly, simple, but well desgined outputs
• Rapid calculation and analysis (no human detectable delay, <= 2s)
• System resource = basic linux setup
• Network resources = requires internet access