NREL / BioproductTransitionDynamics

A system dynamics decision support tool for bioproduct industry stakeholders who want to investigate how their decisions can impact the process of bioproducts gaining U.S. market share.
https://bioenergymodels.nrel.gov/models/14/
1 stars 0 forks source link

add documentation comments to Vensim file #69

Closed rjhanes closed 4 years ago

rjhanes commented 4 years ago

Make changes in documentation branch or create a new branch off documentation for your edits. If editing in documentation branch, git pull before every work session to avoid merging issues.

Add brief (1-3 phrases or sentences) comments to non-shadow variables and parameters. Give default values for input parameters and describe default behavior for variables.

Comment on this issue with any questions and tag Rebecca or Brian.

View Assignee Status
Investor Decisions Lauren
Investor Computations Lauren
Developer Decisions Rebecca complete
Research Costs and Process Anthony complete
Piloting and Demoing Costs Anthony complete
Piloting and Demoing Process Anthony complete
Regulatory Delays Rebecca complete
Commercial Costs Rebecca complete
Commercial Process Anthony complete
Market Share Anthony complete
Income Statement Brian complete
Cash Flow Statement & Balance Sheet Brian complete
Timeline Rebecca complete
Idealized Forecast Brian complete
Shared Learning Rebecca complete
Technology Readiness Level Anthony complete
Price Models Rebecca complete
Indicator Variables Rebecca complete
Development Stages Rebecca complete
Flow Dampers Rebecca complete
bwbush commented 4 years ago

I'd like to emphasize how important it is that we enter the minimum and/or maximum legal values of variables whenever that is knowable. Vensim will alert users when passing outside these ranges. For constant variables, these ranges are helpful in setting up sensitivity analyses and in stress testing the model.