Merge pull request #67 from arfc/example_dpr_tod

Example of DPR and TOD archetypes

Author: nsryan2

CHANGELOG.md

@@ -31,3 +31,4 @@ Includes analysis notebooks.
 * Baseline recycle scenario analysis (#20, #37, #57)
 * Preference analysis (#6, #15, #37, #57, #62)
 * Baseline cycamore example (#2, #37, #57, #62)
+* DPR and TOD example (#67)

DPR/README.md

@@ -1,5 +1,5 @@
 # Dynamic Power Reactor (DPR)
-DPR is a Cyclus reactor archetype based on Cycamore's Reactor, except that it has the ability to update the power output over time.
+DPR (pronounced *dipper*) is a Cyclus reactor archetype based on Cycamore's Reactor, except that it has the ability to update the power output over time.
 
 ## Cite this work
 Pending...
@@ -29,3 +29,5 @@ If the simulation was extended to 11 time steps with out the list changing, the
 > we recommend that you ensure your outages align with when the reactor goes
 > into outage if you are modeling a historical example.
 
+## Example
+In the example folder we provide the input files and scripts used to generate the data.

DPR/example/README.md

@@ -0,0 +1,9 @@
+# DPR Example
+
+This folder contains a script to generate power data in a Cyclus xml format and an example simulation of the Clinton Power Plant in 2024.
+
+You can run the example with:
+```
+python generate_power_percent.py
+cyclus -i clinton_dpr_cycamore_demo.xml -o clinton_2024_dpr_cycamore_demo.sqlite
+```