Add documentation and comments for pulse size #47
Conversation
Codecov Report
@@ Coverage Diff @@
## master #47 +/- ##
=======================================
Coverage 90.37% 90.37%
=======================================
Files 12 12
Lines 187 187
=======================================
Hits 169 169
Misses 18 18
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
README.md
Outdated
|
|
||
| ### Pulse Size Details | ||
|
|
||
| By default, MimiDICE2010 will calculate the SCC using a marginal emissions pulse of 10 GtCO2 spread over ten years, or 1 GtCO2 per year for ten years. The SCC will always be returned in $ per ton CO2 since is normalized by this pulse size. This choice of pulse size and duration is a decision made based on experiments with stability of results and moving from continuous to discretized equations, and can be found described further in the literature around DICE. |
There was a problem hiding this comment.
I think that is incorrect. The unit of pulse_size is GtC, not GtCO2, and the default parameter value is 1e10, so the default pulse size is 10 GtC. It might make sense, though, to change the unit of pulse_size to GtCO2, just to have everything uniform?
README.md
Outdated
| compute_scc(m::Model=get_model(); year::Union{Int, Nothing}=nothing, last_year::Int=model_years[end], | ||
| prtp::Float64=0.015, eta::Float64=1.5, pulse_size=1e10) | ||
| ``` | ||
| where `pulse_size` controls the size of the marginal emission pulse in GtCO2. |
There was a problem hiding this comment.
Again, at the moment the unit is GtC, as far as I can tell.
|
@davidanthoff fixed! |
Co-authored-by: David Anthoff <[email protected]>
|
@davidanthoff ready for merge! |
#32