{"id":13574757,"url":"https://github.com/arfc/openmcyclus","last_synced_at":"2025-12-30T06:05:23.765Z","repository":{"id":72727023,"uuid":"587457528","full_name":"arfc/openmcyclus","owner":"arfc","description":"Repository of Cyclus archetypes to couple Cyclus with OpenMc","archived":false,"fork":false,"pushed_at":"2024-07-18T17:19:47.000Z","size":27579,"stargazers_count":0,"open_issues_count":4,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-08-02T15:12:07.053Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arfc.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-10T19:51:48.000Z","updated_at":"2024-07-18T17:19:51.000Z","dependencies_parsed_at":"2024-06-13T20:31:52.423Z","dependency_job_id":"8841fa28-9591-4e30-a539-11e4dddffaaa","html_url":"https://github.com/arfc/openmcyclus","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arfc%2Fopenmcyclus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arfc%2Fopenmcyclus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arfc%2Fopenmcyclus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arfc%2Fopenmcyclus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arfc","download_url":"https://codeload.github.com/arfc/openmcyclus/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223153557,"owners_count":17096554,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T15:00:54.444Z","updated_at":"2025-12-30T06:05:18.735Z","avatar_url":"https://github.com/arfc.png","language":"Jupyter Notebook","funding_links":[],"categories":["Fuel Cycle"],"sub_categories":["Related Tools"],"readme":"OpenMCyclus\n------------\n.. image:: https://github.com/arfc/openmcyclus/actions/workflows/test-openmcyclus.yml/badge.svg?branch=main\n\nLibrary of Cyclus archetypes to couple Cyclus with OpenMC.\n\nInstallation \n============\n\nDependencies\n~~~~~~~~~~~~\n\nYou will need to have `Cyclus \u003chttps://fuelcycle.org/\u003e`_, `OpenMC \u003chttps://docs.openmc.org\u003e`_, \nand their required dependencies. Both are available via conda binaries or can \nbe installed from source via their github repositories. Please note \nthe versions listed below, as these are *required versions, not minimum versions*. \n\n+---------------+----------+\n| Dependency    | Version  |\n+===============+==========+\n| Cyclus        | 1.6      |\n+---------------+----------+\n| OpenMC        | 0.14     |\n+---------------+----------+\n| SciPy         | 1.11     |\n+---------------+----------+\n\nDirections to install Cyclus and OpenMC [1]_ \n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nIt is advised to create a new conda environment for installing all of the dependencies. \n\n.. code-block:: bash\n  \n    ~ $ conda install -y mamba\n\n    ~ $ mamba install -y cyclus openmc=0.14.0 scipy=1.11\n\n    ~ $ git clone https://github.com/cyclus/cyclus.git\n\n    ~ $ cd cyclus\n\n    ~/cyclus $ python install.py\n\nIf desired, Cycamore can be installed from `source \u003chttps://github.com/cyclus/cycamore\u003e`_ \nor from Conda/Mamba. Cycamore is *highly* recommended, as it contains other archetypes for creating a \nfuel cycle model in Cyclus, but it is not a dependency for OpenMCyclus. \n\nInstall OpenMCyclus\n~~~~~~~~~~~~~~~~~~~\n\nTo install OpenMCyclus:\n\n.. code-block:: bash\n\n    ~ $ git clone https://github.com/arfc/openmcyclus.git \n\n    ~ $ cd openmcyclus\n\n    ~/openmcyclus/ $ pip install .\n\n\nTo run the tests:\n\n.. code-block:: bash\n\n    ~/openmcyclus $ pytest tests/\n\n\nRunning\n=======\n\nThis archetype assumes that you have a defined material file for OpenMC (``.xml``), \na flux value for the fuel assemblies, and the required microscopic cross sections \n(``.csv`` file) for the model. \nThe cross section data must be saved as a ``.csv`` file. These files must \nall be in the same location. Information about these can be found on the \n`OpenMC docpages \u003chttps://docs.openmc.org\u003e`_. \n\nThis archetype is then called during a Cyclus simulation by calling \nthe ``DepleteReactor`` archetype from the ``openmcyclus.DepleteReactor`` \nlibrary. The input structure is:\n\n.. code-block:: xml\n\n   \u003cDepleteReactor\u003e\n          \u003cfuel_incommods\u003e\n            \u003cval\u003estring\u003c/val\u003e\n            \u003cval\u003estring\u003c/val\u003e\n          \u003c/fuel_incommods\u003e\n          \u003cfuel_prefs\u003e\n            \u003cval\u003edouble\u003c/val\u003e\n            \u003cval\u003edouble\u003c/val\u003e\n          \u003c/fuel_prefs\u003e\n          \u003cfuel_outcommods\u003e\n            \u003cval\u003estring\u003c/val\u003e\n            \u003cval\u003estring\u003c/val\u003e\n          \u003c/fuel_outcommods\u003e\n          \u003cfuel_inrecipes\u003e\n            \u003cval\u003estring\u003c/val\u003e \n            \u003cval\u003estring\u003c/val\u003e\n          \u003c/fuel_inrecipes\u003e\n          \u003cfuel_outrecipes\u003e\n            \u003cval\u003estring\u003c/val\u003e \n            \u003cval\u003estring\u003c/val\u003e\n          \u003c/fuel_outrecipes\u003e\n          \u003cassem_size\u003edouble\u003c/assem_size\u003e\n          \u003ccycle_time\u003eint\u003c/cycle_time\u003e\n          \u003crefuel_time\u003eint\u003c/refuel_time\u003e\n          \u003cn_assem_core\u003eint\u003c/n_assem_core\u003e\n          \u003cn_assem_batch\u003eint\u003c/n_assem_batch\u003e\n          \u003cpower_cap\u003edouble\u003c/power_cap\u003e\n          \u003cmodel_path\u003estring\u003c/model_path\u003e\n          \u003cchain_file\u003estring\u003c/chain_file\u003e\n          \u003cflux\u003edouble\u003c/flux\u003e\n          \u003cthermal_power\u003edouble\u003c/thermal_power\u003e\n        \u003c/DepleteReactor\u003e\n\nSome notes about this input structure:\n\n- ``fuel_prefs`` and ``fuel_inrecipes`` must be equal in length to \n  ``fuel_incommods`` and ``fuel_outrecipes`` must be equal in length to ``fuel_outcommods``. \n\n- The ``model_path`` variable is the location of the files for OpenMC (can be \n  relative or absolute path): one-group cross sections, materials, and depletion \n  chain file. If using a relative path, it must be relative to the directory you are \n  running the Cyclus input file from, not the location of the file that defines the \n  prototype. \n\n- The archetype assumes that \n  the OpenMC materials are in the file called ``materials.xml`` and that the cross \n  section data is in a file called ``micro_xs.csv``. \n\n- The ``chain_file`` variable \n  is the depletion chain file, and the user provides the name of this file. \n\n- Each material in the ``materials.xml`` file that are fuel materials must \n  be marked as ``depletable`` and have the name ``assembly_#``. Define one material \n  for each assembly in the reactor core (matches with ``n_assem_core``),  \n  the number assigned to each material name is irrelevant, just as long as  \n  there is one. \n\nOutputs\n~~~~~~~\nThe results of the simulation will be written to `cyclus.sqlite`\nor the file name provided when Cyclus was called. \n\n.. [1] More installation options and instructions for installing OpenMC\n  can be found at https://docs.openmc.org/en/stable/quickinstall.html\n  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farfc%2Fopenmcyclus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farfc%2Fopenmcyclus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farfc%2Fopenmcyclus/lists"}