Nuclear Engineering Division

Software:

ETOE-2
MC2-3
SDX

PROTEUS

DIF3D
DIF3DK

REBUS-3
RCT
ORIGEN-RA

ADDER

VARI3D

PERSENT

SE2-ANL (SUPERENERGY2)

DASSH

SAS4A/SASSYS-1
SAM

MSET
PRO-AID

PyARC

OTERR

DYMOND

ACCERT

NE-COST


Join us on Facebook Follow us on Twitter NE on Flickr NE on YouTube

Reactors designed by Argonne National Laboratory

Software

PyARC (User Interface to ARC Codes)

 
PPyARC Module

Standard Code Description

  1. Name of Program:
    PyARC
  2. Computer for Which Program is Designed and Other Machine Version Packages Available:
    Any workstation that runs the ARC codes
  3. Description of Problem or Function:
    The PyARC module is the glue between the Workbench interface and the ARC codes. The Workbench interface is developed at ORNL and designed to assist new users, while not obstructing experienced ones. The Workbench provides a common user interface for model creation, real-time validation, execution, output processing, and visualization for integrated codes. The PyARC module contains logic to (1) extract information from the common input entered through the Workbench, (2) perform additional verifications on the core model that the validation engine of the Workbench cannot perform, (3) pre-process the information, calculating for instance homogenized atom densities in different regions, (4) generate the ARC codes’ native inputs, (5) handle the runtime environment, for instance running MC2-3 elementary cell calculations in parallel on different CPUs, (6) post-process the outputs, printing out summary files gathering the main results of the different codes’ outputs. It can handle complex workflows between the different integrated codes that are (1) MC2-3 for multi-group cross-section processing with or without coupling with TWODANT or PARTISN, (2) DIF3D/GAMSOR for neutron and gamma transport calculations, (3) REBUS for once-through depletion and equilibrium search, (4) PERSENT for adjoint-based perturbation theory and sensitivity/uncertainty quantification analyses, and (5) PROTEUS for neutron transport calculations.
  4. Restrictions on the Complexity of the Problems:
    The problems solved with PyARC are currently limited to the types of problems solved by the ARC codes. Geometries are limited to 2D/3D Cartesian or Hexagonal-Z geometries.
  5. Typical Running Time:
    PyARC itself does not typically take much time (1s-5min), but the ARC codes that are run can take longer: 1 minminute to 1 hour depending on size and complexity of problem and machine utilized.
  6. Unusual Features of the Program:
    PyARC manages complex workflows between the ARC codes to enables a wide range of analyses in a user-friendly way. For instance, computation of reactivity feedback coefficients is available using both perturbation theory or direct perturbation when changes of geometries are considered. Depletion calculations can be run while updating multi-group cross-sections at different burnup steps. Finally, the Workbench provides straightforward coupling between the Dakota code and the PyARC wrapper to the ARC codes for mathematical optimization and SA/UQ analyses.
  7. Related and Auxiliary Programs:
    PyARC is used under the Workbench interface to execute the different integrated codes that are (1) MC2-3 for multi-group cross-section processing with or without coupling with TWODANT or PARTISN, (2) DIF3D/GAMSOR for neutron and gamma transport calculations, (3) REBUS for once-through depletion and equilibrium search, (4) PERSENT for adjoint-based perturbation theory and sensitivity/uncertainty quantification analyses, and (5) PROTEUS for neutron transport calculations.
  8. Status:
    Version V1.0.0 is available for distribution. Newer versions will be developed and made available in the future.
  9. References:
    1. N. Stauff, P. Lartaud, Y. S. Jung, K. Zeng, J. Hou, “Status of the NEAMS and ARC neutronic fast reactor tools integration to the NEAMS Workbench,” ANL/NEAMS-19/1, Sept. 30, 2019.
    2. Nicolas E. Stauff, Taek K. Kim, Robert A. Lefebvre, Brandon R. Langley, Bradley T. Rearden, “Integration of the Argonne Reactor Computation codes into the NEAMS Workbench," American Nuclear Society Annual Meeting, Philadelphia, PA, USA, June 17-21, 2018.
    3. Kaiyue Zeng, Nicolas Stauff, Jason Hou, T. K. Kim, "Development of multi-objective core optimization framework and application to sodium-cooled fast test reactors," Progress in Nuclear Energy, Volume 120, February 2020.
  10. Machine Requirements:
    Requirements are driven by the applications run with Workbench/PyARC.
  11. Programming Languages Used:
    Python
  12. Operating System:
    No special requirements are made on the operating system. Windows/Linux/MacOS
  13. Other Programming or Operating Information or Restrictions:
  14. Name and Establishment of Author or Contributor:
  15. Materials Available:
    Both Workbench and PyARC are distributed with Open Source Software Licenses.
      1. PyARC: https://code.ornl.gov/neams-workbench/PyARC
      2. Workbench (includes PyARC): https://code.ornl.gov/neams-workbench/downloads
    PyARC require separate license and installation of the MC2-3, ARC, and PROTEUS codes. Code licenses are available through Argonne and through RSICC.
  16. Sponsor:
    U.S. Department of Energy, Office of Nuclear Energy

Last Modified: Wed, June 10, 2020 3:06 PM

 

FEATURED RESOURCES

The NE Computer Codes Suite for Reactor Physics and Fuel Cycle Analysis

For more information:

For more information on this software please send an email to: