Using the Manager Utility
Introduction
The manager utility is used to create basic input module templates, as well as manage the various data bases attached to your model, using a simple command line interface. It is invoked using the following syntax:
oscar5 MY_REACTOR.manager <mode> [options]
The available modes and options will be described in the following sections:
Mode |
Section |
|---|---|
document |
|
facility |
|
inventory |
Note
The available modes and options can always be viewed using the –help switch, that is,
oscar5 MY_REACTOR.manager --help
will list all the available modes, and
oscar5 MY_REACTOR.manager <mode> --help
will list all the available options for the specified mode.
Creating Input Modules
Warning
These have not been ported from the individual application manuals yet!
Facility Loading
Core Follow
Generate Model Documentation
Attention
The way model documentation is generated is currently being ported to the new approach using sphinx directives, which is not compatible with the auto-extraction routine currently implemented in the manager utility. Thus, this command will be deprecated, or its purpose re-formulated, in the near future.
This mode produces the model documentation framework. It scans all input in the model and compose packages and creates a set of restructured text input files, which is the processed into html (or pdf) output using the documentation utility sphinx.
oscar5 MY_REACTOR.manager document [options]
The following options are available:
- --force
Force the regeneration of images and drawing sheets.
Managing the Facility Loading Data Base
The facility data base simply stores the state of the various facilities at different time points, usually described by input in the facility-loading package. Entries can be viewed and modified using the facility mode:
oscar5 MY_REACTOR.manager facility [options]
The following options are available:
- -d, --data-base <str>
Full filepath to the facility management data base. The default is /path/to/MY_REACTOR/MY-REACTOR_facility.
- -i, --info
Prints the list of time point entries in the data base.
- -p, --print <str>
Prints a summary of the facility state at the specified datetime.
Note
The time point can be any value, and is not restricted to points saved in the data base. If a point not in the data base is requested, the state at the nearest point before the specified point will be provided.
- -r, --remove <str>
Remove the specified datetime from the data base.
Attention
In this case, the point must be valid time stamp in the data base, that is, in the list returned by the –info switch.
Attention
Remember to enclose datetime values that contains spaces in quotes, that is
oscar5 MY_REACTOR.manager facility --print '11-JUN-2019 01:00:00'
Managing the Inventory
An inventory stores the irradiation histories of assemblies with transmutable materials. It is usually updated during Core Follow calculations, and assemblies are added using Facility Loading inputs. Any attached inventory can be explored or edited using the inventory mode:
oscar5 MY_REACTOR.manager inventory [options]
The following options are available:
- -p, --path <str>
Full directory path of the inventory. The default is /path/to/MY_REACTOR/MY-REACTOR_inventory.
- -r, --report <str>
Prints a summary of all assembly states in the inventory at the specified datetime.
- -b, --backtrack <str>
Remove all entries in the inventory after the specified datetime.
Attention
This cannot be easily undone, so use with care.
- -t, --timestamps <str>
List all the entries of the specified assembly in the inventory. This gives all the time points at which the history for the assembly was modified.
Example:
oscar5 MY_REACTOR.manager inventory -t TARGET_ASM