ESCOMP / ESCOMP/CDEPS

Add python testing/linting/formatting framework for buildnml?

Open
#435 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Fortran
Stars
32
Forks
68
Avg merge
5d 13h
Merged PRs (30d)
2

Description

This may not be true of all component buildnml's. But, at least the DATM buildnml has a ton of options and a lot of complexity with how the streams work and the namelists created. In CTSM we have a nice framework where python scripts can have unit and system tests, as well as linting and formating through black. It would be good to have something like this in place in CDEPS as well.

I'm starting this as more of a discussion than anything else. This is certainly a post ctsm4.0 release activity.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the CTSM Python testing framework and the DATM buildnml scripts, especially their options, streams, and generated namelists. Define the scope for unit tests, system tests, linting, and Black formatting; done means an agreed framework is in place for the relevant CDEPS buildnml components.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, testing, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.