diff --git a/src/deploy_inst.h b/src/deploy_inst.h index 44db5e377e..87b86da8f7 100644 --- a/src/deploy_inst.h +++ b/src/deploy_inst.h @@ -44,26 +44,30 @@ class DeployInst : public cyclus::Institution { #pragma cyclus var { \ "doc": "Ordered list of prototypes to build.", \ "uitype": ("oneormore", "prototype"), \ + "uilabel": "Prototypes to deploy", \ } std::vector prototypes; #pragma cyclus var { \ - "doc": "Time step on which to build agents given in prototypes (same order).", \ + "doc": "Time step on which to deploy agents given in prototype list (same order).", \ + "uilabel": "Deployment times", \ } std::vector build_times; #pragma cyclus var { \ - "doc": "Number of each prototype in prototypes var to build (same order).", \ + "doc": "Number of each prototype given in prototype list that should be deployed (same order).", \ + "uilabel": "Number to deploy", \ } std::vector n_build; #pragma cyclus var { \ - "doc": "Lifetimes for each prototype in protos (same order)." \ + "doc": "Lifetimes for each prototype in prototype list (same order)." \ " These lifetimes override the lifetimes in the original prototype definition." \ " If unspecified, lifetimes from the original prototype definitions are used." \ " Although a new prototype is created in the Prototypes table for each lifetime with the suffix '_life_[lifetime]'," \ " all deployed agents themselves will have the same original prototype name (and so will the Agents tables).", \ "default": [], \ + "uilabel": "Lifetimes" \ } std::vector lifetimes; }; diff --git a/src/enrichment_facility.h b/src/enrichment_facility.h index 3b68e837f6..7f6e72c376 100644 --- a/src/enrichment_facility.h +++ b/src/enrichment_facility.h @@ -263,43 +263,50 @@ class Enrichment : public cyclus::Facility { #pragma cyclus var { \ "tooltip": "feed commodity", \ "doc": "feed commodity that the enrichment facility accepts", \ + "uilabel": "Feed Commodity", \ "uitype": "incommodity" \ } std::string feed_commod; #pragma cyclus var { \ "tooltip": "product commodity", \ "doc": "product commodity that the enrichment facility generates", \ + "uilabel": "Product Commodity", \ "uitype": "outcommodity" \ } std::string product_commod; #pragma cyclus var { \ "tooltip": "feed recipe", \ "doc": "recipe for enrichment facility feed commodity", \ + "uilabel": "Feed Recipe", \ "uitype": "recipe" \ } std::string feed_recipe; #pragma cyclus var { \ "tooltip": "tails commodity", \ "doc": "tails commodity supplied by enrichment facility", \ + "uilabel": "Tails Commodity", \ "uitype": "outcommodity" \ } std::string tails_commod; #pragma cyclus var { \ "default": 0.03, "tooltip": "tails assay", \ - "doc": "tails assay from the enrichment process" \ + "uilabel": "Tails Assay", \ + "doc": "tails assay from the enrichment process", \ } double tails_assay; #pragma cyclus var { \ "default": 1e299, \ "tooltip": "SWU capacity (kgSWU/month)", \ + "uilabel": "SWU Capacity", \ "doc": "separative work unit (SWU) capacity of enrichment " \ - "facility (kgSWU/month) " \ + "facility (kgSWU/month) " \ } double swu_capacity; #pragma cyclus var { \ "default": 1e299, "tooltip": "max inventory of feed material (kg)", \ + "uilabel": "Maximum Feed Inventory", \ "doc": "maximum total inventory of natural uranium in " \ - "the enrichment facility (kg)" \ + "the enrichment facility (kg)" \ } double max_feed_inventory; @@ -307,6 +314,7 @@ class Enrichment : public cyclus::Facility { "default": 1.0, \ "tooltip": "maximum allowed enrichment fraction", \ "doc": "maximum allowed weight fraction of U235 in product",\ + "uilabel": "Maximum Allowed Enrichment", \ "schema": '' \ ' ' \ ' ' \ @@ -320,6 +328,7 @@ class Enrichment : public cyclus::Facility { #pragma cyclus var { \ "default": 0, "tooltip": "initial uranium reserves (kg)", \ + "uilabel": "Initial Feed Inventory", \ "doc": "amount of natural uranium stored at the enrichment " \ "facility at the beginning of the simulation (kg)" \ } @@ -328,6 +337,7 @@ class Enrichment : public cyclus::Facility { "default": 1, \ "userlevel": 10, \ "tooltip": "order material requests by U235 content", \ + "uilabel": "Prefer feed with higher U235 content", \ "doc": "turn on preference ordering for input material " \ "so that EF chooses higher U235 content first" \ } diff --git a/src/fuel_fab.h b/src/fuel_fab.h index 8fc3ea3a7f..0161498b21 100644 --- a/src/fuel_fab.h +++ b/src/fuel_fab.h @@ -129,21 +129,25 @@ class FuelFab : public cyclus::Facility { private: #pragma cyclus var { \ "doc": "Commodity on which to request material for filler stream.", \ + "uilabel": "Filler Stream Commodity", \ "uitype": "incommodity", \ } std::string fill_commod; #pragma cyclus var { \ "doc": "Name of recipe to be used in filler material stream requests.", \ + "uilabel": "Filler Stream Recipe", \ "uitype": "recipe", \ } std::string fill_recipe; #pragma cyclus var { \ "doc": "Filler material stream request preference.", \ + "uilabel": "Filler Stream Preference", \ "default": 0, \ } double fill_pref; #pragma cyclus var { \ "doc": "Size of filler material stream inventory.", \ + "uilabel": "Filler Stream Inventory Capacity", \ "units": "kg", \ } double fill_size; @@ -152,11 +156,13 @@ class FuelFab : public cyclus::Facility { #pragma cyclus var { \ "doc": "Ordered list of commodities on which to requesting fissile stream material.", \ + "uilabel": "Fissile Stream Commodities", \ "uitype": ["oneormore", "incommodity"], \ } std::vector fiss_commods; #pragma cyclus var { \ "default": [], \ + "uilabel": "Fissile Stream Preferences", \ "doc": "Fissile stream commodity request preferences for each of the given fissile commodities (same order)." \ " If unspecified, default is to use zero for all preferences.", \ } @@ -165,11 +171,13 @@ class FuelFab : public cyclus::Facility { "doc": "Name for recipe to be used in fissile stream requests." \ " Empty string results in use of an empty dummy recipe.", \ "uitype": "recipe", \ + "uilabel": "Fissile Stream Recipes", \ "default": "", \ } std::string fiss_recipe; #pragma cyclus var { \ "doc": "Size of fissile material stream inventory.", \ + "uilabel": "Fissile Stream Inventory Capacity", \ "units": "kg", \ } double fiss_size; @@ -179,6 +187,7 @@ class FuelFab : public cyclus::Facility { #pragma cyclus var { \ "doc": "Commodity on which to request material for top-up stream." \ " This MUST be set if 'topup_size > 0'.", \ + "uilabel": "Top-up Stream Commodity", \ "default": "", \ "uitype": "incommodity", \ } @@ -186,17 +195,20 @@ class FuelFab : public cyclus::Facility { #pragma cyclus var { \ "doc": "Name of recipe to be used in top-up material stream requests." \ " This MUST be set if 'topup_size > 0'.", \ + "uilabel": "Top-up Stream Recipe", \ "uitype": "recipe", \ "default": "", \ } std::string topup_recipe; #pragma cyclus var { \ "doc": "Top-up material stream request preference.", \ + "uilabel": "Top-up Stream Preference", \ "default": 0, \ } double topup_pref; #pragma cyclus var { \ "doc": "Size of top-up material stream inventory.", \ + "uilabel": "Top-up Stream Inventory Capacity", \ "units": "kg", \ "default": 0, \ } @@ -205,6 +217,8 @@ class FuelFab : public cyclus::Facility { cyclus::toolkit::ResBuf topup; #pragma cyclus var { \ + "uilabel": "Spectrum type", \ + "categorical": ['fission_spectrum_ave','thermal'], \ "doc": "The type of cross-sections to use for composition property calculation." \ " Use 'fission_spectrum_ave' for fast reactor compositions or 'thermal' for thermal reactors.", \ } @@ -212,12 +226,14 @@ class FuelFab : public cyclus::Facility { #pragma cyclus var { \ "doc": "Commodity on which to offer/supply mixed fuel material.", \ + "uilabel": "Output Commodity", \ "uitype": "outcommodity", \ } std::string outcommod; #pragma cyclus var { \ "doc": "Maximum number of kg of fuel material that can be supplied per time step.", \ + "uilabel": "Maximum Throughput", \ "units": "kg", \ } double throughput; diff --git a/src/growth_region.h b/src/growth_region.h index 87526c349c..07584633a9 100644 --- a/src/growth_region.h +++ b/src/growth_region.h @@ -74,20 +74,24 @@ class GrowthRegion : public cyclus::Region { #pragma cyclus var {"tooltip": "commodity in demand", \ "doc": "name of the commodity experiencing a " \ "growth in demand", \ - "uitype": "commodity"} + "uilabel": "Growth Commodity", \ + } std::string commodity_name; #pragma cyclus var {"tooltip": "demand type", \ + "uilabel": "Demand Growth Function Form", \ "doc": "mathematical description of demand growth " \ "(i.e., linear, exponential, piecewise)"} std::vector demand_types; #pragma cyclus var {"tooltip": "demand parameters", \ + "uilabel": "Demand Growth Function Parameters", \ "doc": "parameters that define the behavior of the " \ "demand type function"} std::vector demand_params; #pragma cyclus var {"tooltip": "demand times", \ + "uilabel": "Demand Growth Piecewise Function Times", \ "doc": "vector describing the length of times " \ "regarding the piecewise demand type"} std::vector demand_times; diff --git a/src/manager_inst.h b/src/manager_inst.h index 3b1142b854..5cea34467e 100644 --- a/src/manager_inst.h +++ b/src/manager_inst.h @@ -49,6 +49,7 @@ class ManagerInst #pragma cyclus var {"tooltip": "facility prototypes", \ "doc": "a facility to be managed by the institution", \ + "uilabel": "Prototype List", \ "uitype": ["none", "prototype"]} std::vector prototypes; }; diff --git a/src/reactor.h b/src/reactor.h index 1e7f962a7c..8d9cfcecf4 100644 --- a/src/reactor.h +++ b/src/reactor.h @@ -151,18 +151,21 @@ class Reactor : public cyclus::Facility, #pragma cyclus var { \ "default": 0, \ "doc": "Amount of electrical power the facility produces when operating normally.", \ + "uilabel": "Nominal Reactor Power", \ "units": "MWe", \ } double power_cap; #pragma cyclus var { \ "default": "power", \ + "uilabel": "Power Commodity Name", \ "doc": "The name of the 'power' commodity used in conjunction with a deployment curve.", \ } std::string power_name; //////////// inventory and core params //////////// #pragma cyclus var { \ + "uilabel": "Number of Assemblies per Batch", \ "doc": "Number of assemblies that constitute a single batch." \ "This is the number of assemblies discharged from the core fully burned each cycle." \ "Batch size is equivalent to ``n_assem_batch / n_assem_core``.", \ @@ -170,20 +173,26 @@ class Reactor : public cyclus::Facility, int n_assem_batch; #pragma cyclus var { \ "doc": "Mass (kg) of a single assembly.", \ + "uilabels": "Assembly Mass", \ "units": "kg", \ } double assem_size; #pragma cyclus var { \ + "uilabel": "Number of Assemblies in Core", \ "doc": "Number of assemblies that constitute a full core.", \ } int n_assem_core; #pragma cyclus var { \ "default": 1000000000, \ + "uilabel": "Maximum Spent Fuel Inventory", \ + "units": "assemblies", \ "doc": "Number of spent fuel assemblies that can be stored on-site before reactor operation stalls.", \ } int n_assem_spent; #pragma cyclus var { \ "default": 0, \ + "uilabel": "Minimum Fresh Fuel Inventory", \ + "units": "assemblies", \ "doc": "Number of fresh fuel assemblies to keep on-hand if possible.", \ } int n_assem_fresh; @@ -191,12 +200,14 @@ class Reactor : public cyclus::Facility, ///////// cycle params /////////// #pragma cyclus var { \ "doc": "The duration of a full operational cycle (excluding refueling time) in time steps.", \ + "uilabel": "Cycle Length", \ "units": "time steps", \ } int cycle_time; #pragma cyclus var { \ "doc": "The duration of a full refueling period - the minimum time between" \ " a cycle end and the start of the next cycle.", \ + "uilabel": "Refueling Outage Duration", \ "units": "time steps", \ } int refuel_time; @@ -204,6 +215,7 @@ class Reactor : public cyclus::Facility, "default": 0, \ "doc": "Number of time steps since the start of the last cycle." \ " Only set this if you know what you are doing", \ + "uilabel": "Time Since Start of Last Cycle", \ "units": "time steps", \ } int cycle_step; @@ -211,16 +223,19 @@ class Reactor : public cyclus::Facility, /////// fuel specifications ///////// #pragma cyclus var { \ "uitype": ["oneormore", "incommodity"], \ + "uilabel": "Fresh Fuel Commodity List", \ "doc": "Ordered list of input commodities on which to requesting fuel.", \ } std::vector fuel_incommods; #pragma cyclus var { \ "uitype": ["oneormore", "recipe"], \ + "uilabel": "Fresh Fuel Recipe List", \ "doc": "Fresh fuel recipes to request for each of the given fuel input commodities (same order).", \ } std::vector fuel_inrecipes; #pragma cyclus var { \ "uitype": ["oneormore", "recipe"], \ + "uilabel": "Spent Fuel Recipe List", \ "doc": "Spent fuel recipes corresponding to the given fuel input commodities (same order)." \ " Fuel received via a particular input commodity is transmuted to the recipe specified" \ " here after being burned during a cycle.", \ @@ -228,12 +243,14 @@ class Reactor : public cyclus::Facility, std::vector fuel_outrecipes; #pragma cyclus var { \ "uitype": ["oneormore", "outcommodity"], \ + "uilabel": "Spent Fuel Commodity List", \ "doc": "Output commodities on which to offer spent fuel originally received as each particular " \ " input commodity (same order)." \ } std::vector fuel_outcommods; #pragma cyclus var { \ "default": [], \ + "uilabel": "Fresh Fuel Preference List", \ "doc": "The preference for each type of fresh fuel requested corresponding to each input" \ " commodity (same order). If no preferences are specified, zero is" \ " used for all fuel requests (default).", \ @@ -252,6 +269,7 @@ class Reactor : public cyclus::Facility, /////////// preference changes /////////// #pragma cyclus var { \ "default": [], \ + "uilabel": "Time to Change Fresh Fuel Preference", \ "doc": "A time step on which to change the request preference for a " \ "particular fresh fuel type.", \ } @@ -260,11 +278,13 @@ class Reactor : public cyclus::Facility, "default": [], \ "doc": "The input commodity for a particular fuel preference change." \ " Same order as and direct correspondence to the specified preference change times.", \ + "uilabel": "Commodity for Changed Fresh Fuel Preference", \ "uitype": ["oneormore", "incommodity"], \ } std::vector pref_change_commods; #pragma cyclus var { \ "default": [], \ + "uilabel": "Changed Fresh Fuel Preference", \ "doc": "The new/changed request preference for a particular fresh fuel." \ " Same order as and direct correspondence to the specified preference change times.", \ } @@ -273,11 +293,13 @@ class Reactor : public cyclus::Facility, ///////////// recipe changes /////////// #pragma cyclus var { \ "default": [], \ + "uilabel": "Time to Change Fresh/Spent Fuel Recipe", \ "doc": "A time step on which to change the input-output recipe pair for a requested fresh fuel.", \ } std::vector recipe_change_times; #pragma cyclus var { \ "default": [], \ + "uilabel": "Commodity for Changed Fresh/Spent Fuel Recipe", \ "doc": "The input commodity indicating fresh fuel for which recipes will be changed." \ " Same order as and direct correspondence to the specified recipe change times.", \ "uitype": ["oneormore", "incommodity"], \ @@ -285,6 +307,7 @@ class Reactor : public cyclus::Facility, std::vector recipe_change_commods; #pragma cyclus var { \ "default": [], \ + "uilabel": "New Recipe for Fresh Fuel", \ "doc": "The new input recipe to use for this recipe change." \ " Same order as and direct correspondence to the specified recipe change times.", \ "uitype": ["oneormore", "recipe"], \ @@ -292,6 +315,7 @@ class Reactor : public cyclus::Facility, std::vector recipe_change_in; #pragma cyclus var { \ "default": [], \ + "uilabel": "New Recipe for Spent Fuel", \ "doc": "The new output recipe to use for this recipe change." \ " Same order as and direct correspondence to the specified recipe change times.", \ "uitype": ["oneormore", "recipe"], \ @@ -300,12 +324,16 @@ class Reactor : public cyclus::Facility, // should be hidden in ui (internal only). True if fuel has already been // discharged this cycle. - #pragma cyclus var {"default": 0, "doc": "This should NEVER be set manually."} + #pragma cyclus var {"default": 0, "doc": "This should NEVER be set manually.", \ + "internal": True \ + } bool discharged; // This variable should be hidden/unavailable in ui. Maps resource object // id's to the index for the incommod through which they were received. - #pragma cyclus var {"default": {}, "doc": "This should NEVER be set manually."} + #pragma cyclus var {"default": {}, "doc": "This should NEVER be set manually.", \ + "internal": True \ + } std::map res_indexes; }; diff --git a/src/separations.h b/src/separations.h index f0cee6a025..809f7b212b 100644 --- a/src/separations.h +++ b/src/separations.h @@ -98,6 +98,7 @@ class Separations : public cyclus::Facility { private: #pragma cyclus var { \ "doc" : "Maximum quantity of feed material that can be processed per time step.", \ + "uilabel": "Maximum Separations Throughput", \ "units": "kg", \ } double throughput; @@ -105,12 +106,14 @@ class Separations : public cyclus::Facility { #pragma cyclus var { \ "doc": "Ordered list of commodities on which to request feed material to separate." \ " Order only matters for matching up with feed commodity preferences if specified.", \ + "uilabel": "Feed Commodity List", \ "uitype": ["oneormore", "incommodity"], \ } std::vector feed_commods; #pragma cyclus var { \ "default": [], \ + "uilabel": "Feed Commodity Preference List", \ "doc": "Feed commodity request preferences for each of the given feed commodities (same order)." \ " If unspecified, default is to use zero for all preferences.", \ } @@ -119,6 +122,7 @@ class Separations : public cyclus::Facility { #pragma cyclus var { \ "doc": "Name for recipe to be used in feed requests." \ " Empty string results in use of a dummy recipe.", \ + "uilabel": "Feed Commodity Recipe List", \ "uitype": "recipe", \ "default": "", \ } @@ -126,6 +130,7 @@ class Separations : public cyclus::Facility { #pragma cyclus var { \ "doc" : "Maximum amount of feed material to keep on hand.", \ + "uilabel": "Maximum Feed Inventory", \ "units" : "kg", \ } double feedbuf_size; @@ -139,6 +144,7 @@ class Separations : public cyclus::Facility { "doc" : "Maximum amount of leftover separated material (not included in" \ " any other stream) that can be stored." \ " If full, the facility halts operation until space becomes available.", \ + "uilabel": "Maximum Leftover Inventory", \ "default": 1e299, \ "units": "kg", \ } @@ -148,6 +154,7 @@ class Separations : public cyclus::Facility { "doc": "Commodity on which to trade the leftover separated material stream." \ " This MUST NOT be the same as any commodity used to define the other separations streams.", \ "uitype": "outcommodity", \ + "uilabel": "Leftover Commodity", \ "default": "default-waste-stream", \ } std::string leftover_commod; @@ -160,6 +167,7 @@ class Separations : public cyclus::Facility { #pragma cyclus var { \ "alias": ["streams", "commod", ["info", "buf_size", ["efficiencies", "comp", "eff"]]], \ "uitype": ["oneormore", "outcommodity", ["pair", "double", ["oneormore", "nuclide", "double"]]], \ + "uilabel": "Separations Streams and Efficiencies", \ "doc": "Output streams for separations." \ " Each stream must have a unique name identifying the commodity on which its material is traded," \ " a max buffer capacity in kg (neg values indicate infinite size)," \ diff --git a/src/sink.h b/src/sink.h index 2219e5c055..3cd405906e 100644 --- a/src/sink.h +++ b/src/sink.h @@ -100,11 +100,13 @@ class Sink : public cyclus::Facility { /// all facilities must have at least one input commodity #pragma cyclus var {"tooltip": "input commodities", \ "doc": "commodities that the sink facility accepts", \ + "uilabel": "List of Input Commodities", \ "uitype": ["oneormore", "incommodity"]} std::vector in_commods; /// monthly acceptance capacity #pragma cyclus var {"default": 1e299, "tooltip": "sink capacity", \ + "uilabel": "Maximum Throughput", \ "doc": "capacity the sink facility can " \ "accept at each time step"} double capacity; @@ -112,12 +114,14 @@ class Sink : public cyclus::Facility { #pragma cyclus var {"default": "", "tooltip": "requested composition", \ "doc": "name of recipe to use for material requests, where " \ "the default (empty string) is to accept everything", \ + "uilabel": "Input Recipe", \ "uitype": "recipe"} std::string recipe_name; /// max inventory size #pragma cyclus var {"default": 1e299, \ "tooltip": "sink maximum inventory size", \ + "uilabel": "Maximum Inventory", \ "doc": "total maximum inventory size of sink facility"} double max_inv_size; diff --git a/src/source.h b/src/source.h index 90cd9857c0..7a7d74b07c 100644 --- a/src/source.h +++ b/src/source.h @@ -71,6 +71,7 @@ class Source : public cyclus::Facility, #pragma cyclus var { \ "tooltip": "source output commodity", \ "doc": "Output commodity on which the source offers material.", \ + "uilabel": "Output Commodity", \ "uitype": "outcommodity", \ } std::string outcommod; @@ -79,6 +80,7 @@ class Source : public cyclus::Facility, "tooltip": "name of material recipe to provide", \ "doc": "Name of composition recipe that this source provides regardless of requested composition." \ " If empty, source creates and provides whatever compositions are requested.", \ + "uilabel": "Output Recipe", \ "default": "", \ "uitype": "recipe", \ } @@ -88,6 +90,7 @@ class Source : public cyclus::Facility, "default": 1e299, \ "tooltip": "per time step throughput", \ "units": "kg/(time step)", \ + "uilabel": "Maximum Throughput", \ "doc": "amount of commodity that can be supplied at each time step", \ } double throughput; @@ -97,6 +100,7 @@ class Source : public cyclus::Facility, " Every trade decreases this value by the supplied material quantity'." \ " When it reaches zero, the source cannot provide any more material.", \ "default": 1e299, \ + "uilabel": "Initial Inventory", \ "units": "kg", \ } double inventory_size;