From b3c2048c99982f43ebdcf782ac0e245b946b62df Mon Sep 17 00:00:00 2001 From: abachmann Date: Mon, 1 Apr 2024 11:40:26 -0500 Subject: [PATCH] fix formatting for third-party archetypes, add links --- source/user/index.rst | 50 ++++++++++++++++++++++++++----------------- 1 file changed, 30 insertions(+), 20 deletions(-) diff --git a/source/user/index.rst b/source/user/index.rst index c89750b9..6fb8f5a6 100644 --- a/source/user/index.rst +++ b/source/user/index.rst @@ -93,14 +93,14 @@ not necessarily adhere to the same standards of quality (documentation, testint, etc.) as Cyclus and Cycamore code - users are responsible for evaluating their suitability. -**Bright-lite** - The University of Texas - Austin is developing a set of archetypes for fuel +**Bright-lite** (https://github.com/bright-dev/Bright-lite) + The University of Texas - Austin developed a set of archetypes for fuel fabrication and reactors that rely on interpolation tables for more accurate prediction of fresh fuel compositions and estimates of fuel depletion. -**Cyborg** - The University of Tennessee is working with Oak Ridge National Lab to +**Cyborg** (https://github.com/sskutnik/cyborg) + The University of Tennessee worked with Oak Ridge National Lab to develop archetypes that will use ORIGEN calculations to improve the estimate of nuclear fuel properties. @@ -134,37 +134,47 @@ evaluating their suitability. `_ **Peddler** (https://github.com/ergs/peddler) -Peddler is a Cyclus Package used to simulate the transport of material from one facility to another. + Peddler is a Cyclus Package used to simulate the transport of material from one + facility to another. -- `peddler:truck`_ +- `peddler:truck `_ -- `peddler:reactor_` +- `peddler:reactor `_ -**Cyder**(https://github.com/arfc/cyder) -A generic nuclear repository model intended to be used within the Cyclus nuclear fuel cycle simulator. It contains a conditioning facility and a nuclear repository model that places spent fuel packages in a repository based on its temperature and the constraints of the repository. +**Cyder** (https://github.com/arfc/cyder) + A generic nuclear repository model intended to be used within the Cyclus nuclear + fuel cycle simulator. It contains a conditioning facility and a nuclear repository + model that places spent fuel packages in a repository based on its temperature and + the constraints of the repository. -**OpenMCyclus**(https://github.com/arfc/openmcyclus/) -OpenMCyclus introduces an archetype that couples OpenMC depletion with Cyclus a reactor. +**OpenMCyclus** (https://github.com/arfc/openmcyclus/) + OpenMCyclus introduces an archetype that couples OpenMC depletion with Cyclus a + reactor. -- `openmcyclus:DepleteReactor`_ +- `openmcyclus:DepleteReactor `_ -**D3ploy**(https://github.com/arfc/d3ploy/) -A collection of Cyclus manager archetypes for demand driven deployment. The goal of this package is to provide three types of mathematical basis for predicting supply and demand of commodities within Cyclus; Non-optimizing (NO) deterministic optimization (DO), and Stochastic optimization (SO). +**D3ploy** (https://github.com/arfc/d3ploy/) + A collection of Cyclus manager archetypes for demand driven deployment. The goal + of this package is to provide three types of mathematical basis for predicting + supply and demand of commodities within Cyclus; Non-optimizing (NO) deterministic + optimization (DO), and Stochastic optimization (SO). -- `d3ploy:DemandDrivenDeploymentInst`_ +- `d3ploy:DemandDrivenDeploymentInst `_ -- `d3ploy:SupplyDrivenDeploymentInst`_ +- `d3ploy:SupplyDrivenDeploymentInst `_ -- `d3ploy:DemandFac`_ +- `d3ploy:DemandFac `_ -**ann_pwr**(https://github.com/jbae11/ann_pwr) -This Cyclus Reactor module is created to perform varying burnup and enrichment calculations for LWRs using a trained neural network model to predict UNF composition. +**ann_pwr** (https://github.com/jbae11/ann_pwr) + This Cyclus Reactor module is created to perform varying burnup and enrichment + calculations for LWRs using a trained neural network model to predict UNF + composition. -- `ann_pwr:ann_pwr`_ +- `ann_pwr:ann_pwr `_ Visualization & Analysis