Alex Goodman created CLIMATE-911:
------------------------------------
Summary: Improvements to configuration file interface
Key: CLIMATE-911
URL: https://issues.apache.org/jira/browse/CLIMATE-911
Project: Apache Open Climate Workbench
Issue Type: Improvement
Components: command line interface
Affects Versions: 1.2.0
Reporter: Alex Goodman
Assignee: Alex Goodman
Priority: Critical
Fix For: 1.3.0
Currently, many of our examples use a YAML configuration file interface, and
evaluations are usually ran in the form {{python <evaluation_script>.py
<config_file>.yaml}}. In an attempt to promote RCMES/OCW among his students,
Paul Loikith had them attempt to run some of these examples, but the process of
editing the configuration files manually felt daunting for many of the
students, especially those without programming experience. In particular, our
current configuration files are not arranged in logical way in which it is
obvious which parts should be edited and which should not for out examples, and
having to manually edit these files each time we need to change something can
be quite cumbersome.
My proposed solution involves parameterizing our configuration files with
jinja2 templates (http://jinja.pocoo.org). This would lead to a new type of
workflow that we need to implement:
1) For each example configuration file, parameterize any fields which should be
changed for running the example multiple times with jinja2 templating syntax.
2) Interactively get the values of each parameterized field from the user.
3) Render the template config file from user input and load it into the RCMES
script.
4) Run the RCMES script as normal and optionally ask if the user wishes to save
the rendered template into a separate configuration file.
Another advantage to this approach is we can potentially reduce the number of
configuration files we need in our examples directory, since many of them are
just small variations on each other.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
