search

energyPATHWAYS / EnergyPATHWAYS

EnergyPATHWAYS model is a professional, open-source energy and carbon planning tool for use in evaluating long-term, economy-wide greenhouse gas mitigation scenarios.
MIT License
45 stars 15 forks source link

Clear, minimal configuration file example #1

Closed mactyr closed 8 years ago

mactyr commented 8 years ago

As a novice developer I want the example configurations.INI to contain only programmatically meaningful, well-described items so that I can learn the configuration options efficiently.

AC

  1. All obsolete fields (e.g. the ones under "[vintage]") are removed from the file.
  2. Each field is preceded with a comment describing what it does and/or some other illustrative example values to try out. (This presumes that the config file format supports comments; if not this may need to be discarded.)
ryandrewjones commented 8 years ago

Good suggestion. A hashtag # can be used for comments: https://docs.python.org/2/library/configparser.html

ryandrewjones commented 8 years ago

Assigning to @BenHaleyEvolvedEnergyResearch for checking branch clear_config_1