From 2b25d414701a2e33f6bf4212a8bee336bc6e8fe0 Mon Sep 17 00:00:00 2001 From: abachmann Date: Thu, 21 Mar 2024 10:04:26 -0500 Subject: [PATCH] Generated master for --- _static/documentation_options.js | 2 +- arche/cli.html | 4 +- arche/cmake.html | 4 +- arche/custom_tables.html | 4 +- arche/cycpp.html | 4 +- arche/dbtypes.html | 4 +- arche/dbtypes.json | 1184 ++++++++--------- arche/decay.html | 4 +- arche/dre.html | 4 +- arche/dynamic_loading.html | 4 +- arche/errors.html | 4 +- arche/hello_world_cpp.html | 4 +- arche/hello_world_py.html | 4 +- arche/index.html | 4 +- arche/logger.html | 4 +- arche/resources.html | 4 +- arche/sim_init.html | 4 +- arche/testing.html | 4 +- arche/timestep.html | 4 +- arche/toolkit.html | 4 +- arche/tour_cpp.html | 4 +- arche/tutorial_cpp/index.html | 4 +- arche/tutorial_cpp/input_files.html | 4 +- arche/tutorial_cpp/setup.html | 4 +- arche/tutorial_cpp/state_var.html | 4 +- arche/tutorial_cpp/testing.html | 4 +- arche/tutorial_cpp/toolkit.html | 4 +- arche/tutorial_py/index.html | 4 +- arche/tutorial_py/input_files.html | 4 +- arche/tutorial_py/setup.html | 4 +- arche/tutorial_py/state_var.html | 4 +- arche/tutorial_py/testing.html | 4 +- arche/tutorial_py/toolkit.html | 4 +- basics/acknowledgements.html | 4 +- basics/concepts.html | 4 +- basics/ecosystem.html | 4 +- basics/fcs_background.html | 4 +- basics/glossary.html | 4 +- basics/index.html | 4 +- basics/optsens.html | 4 +- basics/projects.html | 4 +- basics/sw_dev.html | 4 +- cep/cep0.html | 4 +- cep/cep1.html | 4 +- cep/cep17.html | 4 +- cep/cep18.html | 4 +- cep/cep19.html | 4 +- cep/cep2.html | 4 +- cep/cep20.html | 4 +- cep/cep21.html | 4 +- cep/cep22.html | 4 +- cep/cep23.html | 4 +- cep/cep24.html | 4 +- cep/cep25.html | 4 +- cep/cep26.html | 4 +- cep/cep27.html | 4 +- cep/cep3.html | 4 +- cep/cep4.html | 4 +- cep/cep5.html | 4 +- cep/cep6.html | 4 +- cep/cep80.html | 4 +- cep/index.html | 4 +- cite/index.html | 4 +- cite/meetings/2014.10.23.ANL.html | 4 +- cite/tutorials/2015-ans-archdev.html | 4 +- cite/tutorials/2015-ans-users.html | 4 +- doctrees/environment.pickle | Bin 13814155 -> 13808394 bytes doctrees/python/cycpp.doctree | Bin 592761 -> 592765 bytes doctrees/python/lib.doctree | Bin 222004 -> 220619 bytes doctrees/user/cycamoreagents.doctree | Bin 517704 -> 515048 bytes genindex.html | 6 +- index.html | 4 +- kernel/build_from_source.html | 4 +- kernel/build_with_conda.html | 4 +- kernel/contributing_to_cyclus.html | 4 +- kernel/cycpp.html | 4 +- kernel/index.html | 4 +- kernel/pr_review.html | 4 +- kernel/style_guide.html | 4 +- news/fy16neup.html | 4 +- newsletters/may2018.html | 4 +- newsletters/oct2017.html | 4 +- objects.inv | Bin 23166 -> 23160 bytes previous/index.html | 4 +- previous/release_notes.html | 4 +- previous/v0.2.html | 4 +- previous/v0.3.html | 4 +- previous/v0.4.html | 4 +- previous/v1.0.html | 4 +- previous/v1.1.html | 4 +- previous/v1.2.html | 4 +- previous/v1.3.html | 4 +- previous/v1.5.html | 4 +- py-modindex.html | 4 +- python/actions.html | 4 +- python/agents.html | 4 +- python/cycpp.html | 8 +- python/events.html | 4 +- python/gentypesystem.html | 4 +- python/index.html | 4 +- python/jsoncpp.html | 4 +- python/lazyasd.html | 4 +- python/lib.html | 13 +- python/main.html | 4 +- python/memback.html | 4 +- python/nucname.html | 4 +- python/pyagents.html | 4 +- python/server.html | 4 +- python/simstate.html | 4 +- python/system.html | 4 +- python/typesystem.html | 4 +- python/webapp.html | 4 +- search.html | 4 +- searchindex.js | 2 +- user/CYCAMORE_DEPS.html | 4 +- user/CYCAMORE_INSTALL.html | 4 +- user/CYCLUS_INSTALL.html | 4 +- user/DEPENDENCIES.html | 4 +- user/analysis_usecases.html | 4 +- user/cycamoreagents.html | 49 +- user/cyclusagents.html | 4 +- .../cymetric/api/brightlite_root_metrics.html | 4 +- user/cymetric/api/cycamore_root_metrics.html | 4 +- user/cymetric/api/evaluator.html | 4 +- user/cymetric/api/execution.html | 4 +- user/cymetric/api/fco_metrics.html | 4 +- user/cymetric/api/filters.html | 4 +- user/cymetric/api/graphs.html | 4 +- user/cymetric/api/index.html | 4 +- user/cymetric/api/main.html | 4 +- user/cymetric/api/metrics.html | 4 +- user/cymetric/api/root_metrics.html | 4 +- user/cymetric/api/schemas.html | 4 +- user/cymetric/api/timeseries.html | 4 +- user/cymetric/api/tools.html | 4 +- user/cymetric/index.html | 4 +- user/cymetric/tutorial_cli.html | 4 +- user/cymetric/tutorial_metrics.html | 4 +- user/cymetric/tutorial_py.html | 4 +- user/dbdoc.html | 4 +- user/find_agents.html | 4 +- user/index.html | 4 +- user/input_specs/archetypes.html | 4 +- user/input_specs/commodity.html | 4 +- user/input_specs/control.html | 4 +- user/input_specs/facility.html | 4 +- user/input_specs/inst.html | 4 +- user/input_specs/recipe.html | 4 +- user/input_specs/region.html | 4 +- user/install.html | 4 +- user/install_binary.html | 4 +- user/install_custom.html | 4 +- user/install_from_git.html | 4 +- user/install_from_tarball.html | 4 +- user/running_sims.html | 4 +- user/server.html | 4 +- user/sim_schema.html | 4 +- user/tutorial/add_arche.html | 4 +- user/tutorial/add_arche_commod_recipe.html | 4 +- user/tutorial/add_commod_recipe.html | 4 +- user/tutorial/add_deploy.html | 4 +- user/tutorial/add_fab.html | 4 +- user/tutorial/add_proto.html | 4 +- user/tutorial/add_reg_inst.html | 4 +- user/tutorial/add_second_reactor.html | 4 +- user/tutorial/add_sep.html | 4 +- user/tutorial/cyclus_tour.html | 4 +- user/tutorial/cyclus_tutorial_recap.html | 4 +- user/tutorial/data_explorer.html | 4 +- user/tutorial/full_input_1.html | 4 +- user/tutorial/future_work.html | 4 +- user/tutorial/index.html | 4 +- user/tutorial/install_launch_cyclus.html | 4 +- user/tutorial/ipython_tour.html | 4 +- user/tutorial/launch_cyclus.html | 4 +- user/tutorial/mod_rxtr.html | 4 +- user/tutorial/plot_output.html | 4 +- user/tutorial/run_cyclus_native.html | 4 +- user/tutorial/sim_parm.html | 4 +- user/unit_test.html | 4 +- user/virtualbox.html | 4 +- user/writing_input.html | 4 +- 182 files changed, 956 insertions(+), 988 deletions(-) diff --git a/_static/documentation_options.js b/_static/documentation_options.js index 239a9b65..cd88070f 100644 --- a/_static/documentation_options.js +++ b/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '(1.5.5-492-g3881109d)', + VERSION: '(1.5.5-808-g08a8cd3b)', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/arche/cli.html b/arche/cli.html index e8cd8c4d..13f1171b 100644 --- a/arche/cli.html +++ b/arche/cli.html @@ -13,7 +13,7 @@ - + @@ -261,7 +261,7 @@

Navigation

+ @@ -318,7 +318,7 @@

Navigation

+ @@ -339,7 +339,7 @@

Navigation

+ @@ -862,7 +862,7 @@

Navigation

+ @@ -328,7 +328,7 @@

Navigation

+ @@ -275,7 +275,7 @@

Navigation

+ @@ -896,7 +896,7 @@

Navigation

+ @@ -175,7 +175,7 @@

Navigation

+ @@ -331,7 +331,7 @@

Navigation

+ @@ -269,7 +269,7 @@

Navigation

+ @@ -271,7 +271,7 @@

Navigation

+ @@ -279,7 +279,7 @@

Navigation

+ @@ -253,7 +253,7 @@

Navigation

+ @@ -518,7 +518,7 @@

Navigation

+ @@ -199,7 +199,7 @@

Navigation

+ @@ -513,7 +513,7 @@

Navigation

+ @@ -289,7 +289,7 @@

Navigation

+ @@ -336,7 +336,7 @@

Navigation

+ @@ -297,7 +297,7 @@

Navigation

+ @@ -209,7 +209,7 @@

Navigation

+ @@ -457,7 +457,7 @@

Navigation

+ @@ -289,7 +289,7 @@

Navigation

+ @@ -364,7 +364,7 @@

Navigation

+ @@ -284,7 +284,7 @@

Navigation

+ @@ -856,7 +856,7 @@

Navigation

+ @@ -199,7 +199,7 @@

Navigation

+ @@ -168,7 +168,7 @@

Navigation

+ @@ -327,7 +327,7 @@

Navigation

+ @@ -379,7 +379,7 @@

Navigation

+ @@ -168,7 +168,7 @@

Navigation

+ @@ -474,7 +474,7 @@

Navigation

+ @@ -200,7 +200,7 @@

Navigation

+ @@ -271,7 +271,7 @@

Navigation

+ @@ -324,7 +324,7 @@

Navigation

+ @@ -224,7 +224,7 @@

Navigation

+ @@ -256,7 +256,7 @@

Navigation

+ @@ -247,7 +247,7 @@

Navigation

+ @@ -172,7 +172,7 @@

Navigation

+ @@ -185,7 +185,7 @@

Navigation

+ @@ -226,7 +226,7 @@

Navigation

+ @@ -258,7 +258,7 @@

Navigation

+ @@ -606,7 +606,7 @@

Navigation

+ @@ -860,7 +860,7 @@

Navigation

+ @@ -663,7 +663,7 @@

Navigation

+ @@ -774,7 +774,7 @@

Navigation

+ @@ -446,7 +446,7 @@

Navigation

+ @@ -382,7 +382,7 @@

Navigation

+ @@ -273,7 +273,7 @@

Navigation

+ @@ -213,7 +213,7 @@

Navigation

+ @@ -319,7 +319,7 @@

Navigation

+ @@ -257,7 +257,7 @@

Navigation

+ @@ -285,7 +285,7 @@

Navigation

+ @@ -362,7 +362,7 @@

Navigation

+ @@ -382,7 +382,7 @@

Navigation

+ @@ -551,7 +551,7 @@

Navigation

+ @@ -310,7 +310,7 @@

Navigation

+ @@ -237,7 +237,7 @@

Navigation

+ @@ -291,7 +291,7 @@

Navigation

+ @@ -239,7 +239,7 @@

Navigation

+ @@ -258,7 +258,7 @@

Navigation

+ @@ -217,7 +217,7 @@

Navigation

+ @@ -254,7 +254,7 @@

Navigation

+ @@ -186,7 +186,7 @@

Navigation

+ @@ -167,7 +167,7 @@

Navigation

+ @@ -4892,8 +4892,6 @@

P

  • py_append_init_tab() (in module cyclus.lib) -
  • -
  • py_import_call_init() (in module cyclus.lib)
  • py_import_init() (in module cyclus.lib)
  • @@ -8671,7 +8669,7 @@

    Navigation

    + @@ -260,7 +260,7 @@

    Navigation

    + @@ -270,7 +270,7 @@

    Navigation

    + @@ -229,7 +229,7 @@

    Navigation

    + @@ -371,7 +371,7 @@

    Navigation

    + @@ -950,7 +950,7 @@

    Navigation

    + @@ -238,7 +238,7 @@

    Navigation

    + @@ -319,7 +319,7 @@

    Navigation

    + @@ -188,7 +188,7 @@

    Navigation

    + @@ -190,7 +190,7 @@

    Navigation

    + @@ -184,7 +184,7 @@

    Navigation

    + @@ -276,7 +276,7 @@

    Navigation

    + @@ -360,7 +360,7 @@

    Navigation

    + @@ -235,7 +235,7 @@

    Navigation

    + @@ -292,7 +292,7 @@

    Navigation

    + @@ -504,7 +504,7 @@

    Navigation

    + @@ -275,7 +275,7 @@

    Navigation

    + @@ -269,7 +269,7 @@

    Navigation

    + @@ -241,7 +241,7 @@

    Navigation

    + @@ -230,7 +230,7 @@

    Navigation

    + @@ -304,7 +304,7 @@

    Navigation

    + @@ -301,7 +301,7 @@

    Navigation

    + @@ -311,7 +311,7 @@

    Navigation

    + @@ -363,7 +363,7 @@

    Navigation

    + @@ -1598,7 +1598,7 @@

    Navigation

    + @@ -298,7 +298,7 @@

    Navigation

    -regex = re.compile('(?:\\s*template\\s*<[\\s\\w,]*>)?\\s*(?:class|struct)\\s+(\\w+)(\\s*:[\n\\s\\w,:]+)?\\s*', re.DOTALL)¶
    +regex = re.compile('(?:\\s*template\\s*<[\\s\\w,]*>)?\\s*(?:class|struct)\\s+(\\w+)(\\s*:[\\n\\s\\w,:]+)?\\s*', re.DOTALL)¶
    @@ -332,7 +332,7 @@

    Navigation

    -regex = re.compile('(?:\\s*template\\s*<[\\s\\w,]*>)?\\s*(?:class|struct)\\s+(\\w+)(\\s*:[\n\\s\\w,:]+)?\\s*', re.DOTALL)¶
    +regex = re.compile('(?:\\s*template\\s*<[\\s\\w,]*>)?\\s*(?:class|struct)\\s+(\\w+)(\\s*:[\\n\\s\\w,:]+)?\\s*', re.DOTALL)¶
    @@ -2442,7 +2442,7 @@

    Navigation

    + @@ -180,7 +180,7 @@

    Navigation

    + @@ -411,7 +411,7 @@

    Navigation

    + @@ -228,7 +228,7 @@

    Navigation

    + @@ -480,7 +480,7 @@

    Navigation

    + @@ -164,7 +164,7 @@

    Navigation

    + @@ -1278,14 +1278,6 @@

    Parameters: -
    -cyclus.lib.py_import_call_init()¶
    -

    Calls Cyclus-internal Python imports. This is called -automatically when cyclus is imported. Users should not need to call -this function.

    -

    -
    cyclus.lib.py_import_init()¶
    @@ -1568,7 +1560,6 @@

    Page contents

  • normalize_bid_portfolio()
  • normalize_request_portfolio()
  • py_append_init_tab()
  • -
  • py_import_call_init()
  • py_import_init()
  • py_to_json()
  • py_to_xml()
  • @@ -1654,7 +1645,7 @@

    Navigation

    + @@ -742,7 +742,7 @@

    Navigation

    + @@ -279,7 +279,7 @@

    Navigation

    + @@ -892,7 +892,7 @@

    Navigation

    + @@ -1713,7 +1713,7 @@

    Navigation

    + @@ -444,7 +444,7 @@

    Navigation

    + @@ -321,7 +321,7 @@

    Navigation

    + @@ -165,7 +165,7 @@

    Navigation

    + @@ -16424,7 +16424,7 @@

    Navigation

    + @@ -201,7 +201,7 @@

    Navigation

    + @@ -159,7 +159,7 @@

    Navigation

    + @@ -255,7 +255,7 @@

    Navigation

    + @@ -333,7 +333,7 @@

    Navigation

    + @@ -362,7 +362,7 @@

    Navigation

    + @@ -459,7 +459,7 @@

    Navigation

    + @@ -382,7 +382,7 @@

    Navigation

    + @@ -3313,40 +3313,24 @@

    State Variablesactive_buying: -

    int, optional (default=1), shape=[-1]

    -

    During the length of the active buying period, agent exhibits regular behavior. If paired with dormant buying period, alternates between buying and not buying, regardless if space is available

    -

    XML:

    -
    <active_buying>[int]</active_buying>
    -
    -
    -

    JSON:

    -
    {"active_buying": 1}  # int
    -
    -
    -

    Python:

    -
    {"active_buying": 1}  # int, optional
    -
    -
    -
    -
    dormant_buying:
    -

    int, optional (default=0), shape=[-1]

    -

    During the length of the dormant buying period, agent will not request any new material from the DRE. Paired with active buying period, alternates between buying and not buying, regardless if space is available

    +
    cumulative_cap:
    +

    double, optional (default=-1), shape=[-1]

    +

    After receiving this much material cumulatively, the agent will go dormant. Must be paired with dormant_buying_frequency_type and any other dormant parameters. The per-time step demand is unchanged except the cycle cap is almost reached.

    XML:

    -
    <dormant_buying>[int]</dormant_buying>
    +
    <cumulative_cap>[double]</cumulative_cap>
     

    JSON:

    -
    {"dormant_buying": 0}  # int
    +
    {"cumulative_cap": -1}  # double
     

    Python:

    -
    {"dormant_buying": 0}  # int, optional
    +
    {"cumulative_cap": -1}  # double, optional
     
    -
    latitude:
    -

    double, optional (default=0.0), shape=[-1]

    +
    latitude:
    +

    double, optional (default=0.0), shape=[-1]

    Latitude of the agent’s geographical position. The value should be expressed in degrees as a double.

    XML:

    <latitude>[double]</latitude>
    @@ -3361,8 +3345,8 @@ 

    State Variableslongitude: -

    double, optional (default=0.0), shape=[-1]

    +
    longitude:
    +

    double, optional (default=0.0), shape=[-1]

    Longitude of the agent’s geographical position. The value should be expressed in degrees as a double.

    XML:

    <longitude>[double]</longitude>
    @@ -3545,13 +3529,8 @@ 

    XML Input Schema </element> </optional> <optional> - <element name="active_buying"> - <data type="int"/> - </element> - </optional> - <optional> - <element name="dormant_buying"> - <data type="int"/> + <element name="cumulative_cap"> + <data type="double"/> </element> </optional> <optional> @@ -4562,7 +4541,7 @@

    Navigation

    + @@ -1155,7 +1155,7 @@

    Navigation

    + @@ -169,7 +169,7 @@

    Navigation

    + @@ -169,7 +169,7 @@

    Navigation

    + @@ -214,7 +214,7 @@

    Navigation

    + @@ -247,7 +247,7 @@

    Navigation

    + @@ -169,7 +169,7 @@

    Navigation

    + @@ -288,7 +288,7 @@

    Navigation

    + @@ -198,7 +198,7 @@

    Navigation

    + @@ -200,7 +200,7 @@

    Navigation

    + @@ -191,7 +191,7 @@

    Navigation

    + @@ -282,7 +282,7 @@

    Navigation

    + @@ -185,7 +185,7 @@

    Navigation

    + @@ -238,7 +238,7 @@

    Navigation

    + @@ -309,7 +309,7 @@

    Navigation

    + @@ -306,7 +306,7 @@

    Navigation

    + @@ -188,7 +188,7 @@

    Navigation

    + @@ -389,7 +389,7 @@

    Navigation

    + @@ -278,7 +278,7 @@

    Navigation

    + @@ -245,7 +245,7 @@

    Navigation

    + @@ -574,7 +574,7 @@

    Navigation

    + @@ -269,7 +269,7 @@

    Navigation

    + @@ -364,7 +364,7 @@

    Navigation

    + @@ -264,7 +264,7 @@

    Navigation

    + @@ -237,7 +237,7 @@

    Navigation

    + @@ -345,7 +345,7 @@

    Navigation

    + @@ -263,7 +263,7 @@

    Navigation

    + @@ -295,7 +295,7 @@

    Navigation

    + @@ -295,7 +295,7 @@

    Navigation

    + @@ -270,7 +270,7 @@

    Navigation

    + @@ -238,7 +238,7 @@

    Navigation

    + @@ -278,7 +278,7 @@

    Navigation

    + @@ -271,7 +271,7 @@

    Navigation

    + @@ -339,7 +339,7 @@

    Navigation

    + @@ -349,7 +349,7 @@

    Navigation

    + @@ -232,7 +232,7 @@

    Navigation

    + @@ -234,7 +234,7 @@

    Navigation

    + @@ -492,7 +492,7 @@

    Navigation

    + @@ -399,7 +399,7 @@

    Navigation

    + @@ -220,7 +220,7 @@

    Navigation

    + @@ -571,7 +571,7 @@

    Navigation

    + @@ -274,7 +274,7 @@

    Navigation

    + @@ -226,7 +226,7 @@

    Navigation

    + @@ -767,7 +767,7 @@

    Navigation

    + @@ -592,7 +592,7 @@

    Navigation

    + @@ -303,7 +303,7 @@

    Navigation

    + @@ -261,7 +261,7 @@

    Navigation

    + @@ -147,7 +147,7 @@

    Navigation

    + @@ -1370,7 +1370,7 @@

    Navigation

    + @@ -612,7 +612,7 @@

    Navigation

    + @@ -333,7 +333,7 @@

    Navigation

    + @@ -172,7 +172,7 @@

    Navigation

    + @@ -284,7 +284,7 @@

    Navigation

    + @@ -171,7 +171,7 @@

    Navigation

    + @@ -194,7 +194,7 @@

    Navigation

    + @@ -226,7 +226,7 @@

    Navigation

    + @@ -216,7 +216,7 @@

    Navigation

    + @@ -223,7 +223,7 @@

    Navigation

    + @@ -226,7 +226,7 @@

    Navigation

    + @@ -314,7 +314,7 @@

    Navigation

    + @@ -142,7 +142,7 @@

    Navigation

    + @@ -180,7 +180,7 @@

    Navigation

    + @@ -330,7 +330,7 @@

    Navigation