OSeMOSYS / otoole

OSeMOSYS Tools for Energy
https://otoole.readthedocs.io
MIT License
23 stars 17 forks source link

Deprecates `calculated` field in config file #174

Closed trevorb1 closed 1 year ago

trevorb1 commented 1 year ago

Description

In the config file, results needed to have a calculated field. This True/False field was originally meant to indicate whether the result was produced "naturally" from the solver, or if otoole was meant to calculate it. If calculated=True, then otoole produced the output otherwise it passes through the value from the solver. After discussion with @willu47, the calculated field not really needed now and can be removed as the results_package(..) logic automatically calculates results if they are not present

In this PR, I have deprecated the calculated field. The field wasn't actually used in any logic, so that was easy to implement. If the calculated field is present in the config file, a warning is printed to the screen (as shown below), but the command still runs.

CapitalInvestment -> Config file field of 'calculated' is deprecated. Remove 'calculated' to suppress this warning.
Demand -> Config file field of 'calculated' is deprecated. Remove 'calculated' to suppress this warning.
...

Issue Ticket Number

Closes #173

Documentation

Remove references to the calculated field in the documentation