Welcome to OSCAR-5’s documentation!

Attention

This manual is a work in progress! Large layout and content changes are likely to occur regularly. Expect (and forgive) typos and other errors. Complete API documentation will be added in the near future.

Contents:

• System Overview
  • Introduction
  • What is in the box?
    • The nodal package
    • Input and output processing of external codes
  • The rapyds framework
• External Interfaces (Plugins)
  • Adding Interfaces
• Installation
  • Getting Access to Git Repositories
  • Installation Manuals
    • Installation with Conda
    • Using a Docker Container
    • Docker cheat sheet
    • Compiling from Source
• Working with Git
  • Working with Git in the PyCharm IDE
    • Adding files
    • Committing local changes
    • Pulling updates from the server
    • Pushing updates to the server
    • Adding a new repository
  • Tips and Tricks
    • How to reset your local repository
• A Quick Introduction to the Python Interface
  • Introduction
    • A living input file
  • Python basics
    • The python interpreter
    • Creating variables and assigning data
    • Basic python data types
    • Basic containers
  • System interface basics
    • The import mechanism
    • The member of operator
    • Additional data types
    • Interface elements
• Configuring Hosts
  • Introduction
    • Configuration file syntax
  • Host configuration
    • name
    • username
    • password
    • directory
    • protocol
    • queue
    • project
    • hook
    • spool
    • Simple host configuration example
    • Example of configuring a remote cluster running a PBS
  • Target mode configuration
    • Static target mode configuration
    • Host specific target mode configuration
    • Defining additional modes
  • Complete host configuration file example
• Data Model
  • Specifying Materials
    • Material Data
    • Using material mixers
    • Built-in materials
    • Creating a material library for your model
  • The Constructive Solid Geometry (CSG) package
    • Primitive regions
    • Transformations
    • Regularizing set operations
    • Repeated structures
    • Working with cells
    • Composites
    • Adapters
  • Building Assembly Libraries
    • The Assembly Build Module
    • Choosing an Assembly Class
  • Building Core Configurations
    • Using your assembly library
    • Building the model
  • Assembly Inventories
    • What is the structure of an Inventory?
    • How is an Inventory updated?
    • Exploring inventory contents using the Python API
    • Exploring assembly history files using the Python API
    • Other ways to query Inventory contents
• Using the Manager Utility
  • Introduction
  • Creating Input Modules
    • Facility Loading
    • Core Follow
  • Generate Model Documentation
  • Managing the Facility Loading Data Base
  • Managing the Inventory
• Applications
  • General Application Guidelines
    • The Application Input Module
    • Application Parameters
    • General Application Command Line Interface (CLI)
    • Application Output
  • Viewing and Archiving Assemblies
    • Typical Use Cases
    • Creating an Input Module
    • Additional Input Parameters
    • Command Line Usage
  • Viewing and Archiving Model Configurations
    • Typical Use Cases
    • Creating an Input Module
    • Additional Input Parameters
    • Command Line Usage
    • Examples
  • Create Two Dimensional Plots of Slices Through a Model
    • Typical Use Cases
    • Additional Input Parameters
    • Command Line Usage
    • Examples
  • Check Model Compatibility
    • Typical Use Cases
    • Additional Input Parameters
    • Command Line Usage
    • Examples
  • Steady State Neutron Flux Calculations
    • Typical Use Cases
    • Creating an Input Module
    • Additional Input Parameters
    • Command Line Usage
    • Output Tokens
    • Examples
  • Multiple Steady State Neutron Flux Calculations
    • Typical Use Cases
    • Creating an Input Module
    • Additional Input Parameters
    • Command Line Usage
    • Output Tokens
    • Examples
  • Rod Calibration Calculations
    • Typical Use Cases
    • Creating an Input Module
    • Additional Input Parameters
    • Command Line Usage
    • Output Tokens
    • Examples
  • Rod Calibration Calculations for Multiple Rods
    • Typical Use Cases
    • Creating an Input Module
    • Additional Input Parameters
    • Command Line Usage
    • Output Tokens
    • Examples
  • Facility Management
    • Creating an input module
    • Application parameters
    • Adding assembly batches
    • Specify a facility loading
    • Importers
    • Command line invocation
  • Creation of Burnup Dependent Material Libraries
    • Introduction
    • Exposure application input module
    • How results are used
    • Running exposure calculations on the command line
  • Core Follow or Multi-Step Depletion Calculations
    • Typical Use Cases
    • Creating an Input Module
    • Additional Input Parameters
    • Command Line Usage
    • Output Tokens
    • Examples
  • Performing Reload Calculations
    • Typical Use Cases
    • Creating an Input Module
    • Additional Input Parameters
    • Report Generation
    • Command Line Usage
    • Examples
  • De-Homogenization Tool (ODEHT) User Manual
    • Introduction
    • Requirements
    • Defining the basic core configuration
    • Configuring the history importer
    • The ODEHT input module
    • Running the application
    • Creating template files
  • Document Generation Utility
    • Typical Use Cases
    • Creating an Input Module
    • Input Parameters
    • Command Line Usage
    • Examples
    • Extra Resources
  • Application Data
    • Customizing the depletion mesh
    • Working with Distributions
    • Irradiation histories
  • Plugin Data Model and Application Support
    • Application Support
• cOMPoSe (OSCAR Model Preparation System) User Manual
  • Introduction
  • Typical structure of the compose package for your model
  • Creating and running a cOMPoSe module
    • Getting Started
    • Homogenization Parameters
    • Adding two dimensional axial cuts
    • Adding burnup and state dependent cuts
    • Adding Mixture Replacement Tests
    • Combine cuts to create a 3D reactor model
    • Running a cOMPoSe application module from the terminal
  • Building a automated compose module using auto-compose
    • The basic auto-compose module

Appendix:

• Additional Units
• Data Types
  • HexagonalGrid.set_label()
  • HexagonalGrid.fold()
  • HexagonalGrid.to_grid()
  • HexagonalGrid.from_grid()
• Additional Resources
  • Introduction
  • Tutorials
  • Video Tutorials
  • Presentations
  • Benchmark examples

Indices and tables

• Index

• Module Index

• Search Page