Skip to content

Commit b94a433

Browse files
committed
add section about common inputs, note about recipe names
1 parent 42723b0 commit b94a433

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

source/user/tutorial/add_proto.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,20 @@ reactor parameters are fuel loading parameters such as cycle length and batch
1010
size.
1111

1212
In |Cyclus|, when an archetype has been configured with a
13-
specific set of parameters, it is called a `**prototype** <https://fuelcycle.org/basics/glossary.html#term-prototype>`_. You can have multiple prototypes that use the same
13+
specific set of parameters, it is called a `prototype <https://fuelcycle.org/basics/glossary.html#term-prototype>`_. You can have multiple prototypes that use the same
1414
archetype, and you can have multiple deployments of the same prototype in
1515
a simulation.
1616

17+
Each archetype will have different input parameters that need to be defined
18+
for a given prototype, with some of the parameters being optional (i.e., they
19+
have a default value). Some common input parameters for defining prototypes
20+
include:
21+
22+
* input/output commodity name: Name of the `commodity <https://fuelcycle.org/basics/glossary.html#term-commodity>`_ that the prototype will request (input) or trade away (output).
23+
* input/output recipe name: Name of the **recipe** or isotopic composition for the input or output commodity. Recipe names used in defining a prototype must be defined in a `recipe block <https://fuelcycle.org/user/tutorial/add_commod_recipe.html#understanding-recipes>`_ of the input file.
24+
* throughput: The rate at which the process of a facility occurs. Common units are kg/time step, although you should check the archetypes documentation
25+
* buffer size: The size (typically in kg) of an inventory within a prototype. A prototype may have multiple buffers, such as a reactor having an inventory for fresh fuel and one for fuel in the core.
26+
1727
Example: Source Prototype
1828
+++++++++++++++++++++++++
1929
The Source facility acts as a source of material with a fixed throughput (per

0 commit comments

Comments
 (0)