11.1. dif3ddemo package

11.1.2. Submodules

11.1.3. dif3ddemo.app module

App for demo.

class dif3ddemo.app.Dif3dDragonApp[source]

Bases: armi.apps.App

App that adds only the DIF3D plugin and DRAGON for testing purposes.

This mostly initializes the default plugin manager. Subclasses are free to adopt this plugin manager and register more plugins of their own, or to throw it away and start from scratch if they do not wish to use the default Framework plugins.

For a description of the things that an ARMI plugin can do, see the armi.plugins module.

name = 'dif3ddemo'

The program name of the app. This should be the actual name of the python entry point that loads the app, or the name of the module that contains the appropriate __main__ function. For example, if the app is expected to be invoked with python -m myapp, name should be "myapp"

property splashText

Return a textual splash screen.

Specific applications will want to customize this, but by default the ARMI one is produced.

class dif3ddemo.app.InlDif3dDemoPlugin[source]

Bases: armi.plugins.ArmiPlugin

Plugin with DIF3D testing hooks

static defineEntryPoints()[source]

Return new entry points for the ARMI CLI

This hook allows plugins to provide their own ARMI entry points, which each serve as a command in the command-line interface.

Returns

class objects which derive from the base EntryPoint class.

Return type

list

11.1.4. Module contents

The DIF3D Demonstration Application

This package contains the code that implements the DIF3D Demonstration Application, dif3ddemo. The main ARMI-based application definition lives in dif3ddemo.app.Dif3dDragonApp, which registers the Dif3dPlugin and DragonPlugin ARMI plugins with the ARMI framework. With these plugins dif3ddemo run [settings file] with perform simple neutronics analysis.

In addition, it includes the InlDif3dDemoPlugin plugin, which implements the make-test-fixtures and copy-fixture-files entry points, which are useful for testing-related tasks.