Portable INAS


INAS

The INAS (IRI-NJOY-AMPX-SCALE) software was developed at the reactor physics department of the Interfaculty Reactor Institute, Delft University of Technology as a tool for performing standard tasks for the calculations with reactor physics codes. The software controls a number of tasks such as linking of libraries, submitting code to the queuing system and copying the resulting files to a required directory.

To be able to perform these calculations independent of the computer system Portable INAS was developed.

Portable INAS is able to perform the tasks mentioned above on both VMS and UNIX systems. The architecture enables easy adaptation for use with different computer or software systems.

Back to contents


Overview

The figure shows an overview of the software system Portable INAS.

Grey areas are parts specific for Portable INAS (Portable INAS Perl script, Queuing Perl script, Module i Perl script and Portable INAS Status file). Other areas are standard (User Interface j) or already existing (Module i Executable, Module i Data structure and Queuing system software. The index j indicates that the system is able to handle multiple users at the same time. The index i indicates that the system is able to handle multiple modules. The Moudle i Perl script is a temporary file and is removed after correct completion of the job.

For the user interface a command line interface is chosen enabling its usage in scripts or command files. The code Portable INAS Perl script was written in PERL (= Practical Extraction and Report Language; http://www.perl.com) to ensure a high portability, as Perl is available on virtually any computer system. The code takes care of tasks such as linking of libraries, submitting modules to the queuing system and copying the resulting files to a required directory. To be able to perform all these tasks without mixing them up the code keeps a record of them in a special Portable INAS Status file. For convenience the actual interfacing with the queuing system is done by via the Queuing Perl script. Every computer system has its own (unique) queuing software available or it can even be necessary to create your own queuing system. To use the Portable INAS system for a different queuing system only the Queuing Perl script has to be changed.

Information about the supported computer systems, queuing systems and modules can be found using the help command.

Back to contents


Queuing system

Portable INAS gives the possibility to support several queuing software systems.

The current supported systems are described in the Queuing system.

To be able to use Portable INAS on different computer systems the file that is submitted to the queuing system is a PERL script. This script contains the actions which should be taken before the module executable is run and after the module is finished. For instance the definition of some environment variables needed by the module executable or the creation of some temporary files or directories. The Module Perl script is created by the Portable INAS script using commands which are defined in the Queuing Perl script. Finally this script is submitted to the queuing system.

Back to contents


Commands

Valid Portbale INAS commands are listed below.

HELP

Syntax
INAS [TREE] -help or INAS [TREE] -?

Description
The help command returns the description of the last parameter before the HELP command.

Properties
The parameter [TREE] is optional and represents a valid Portable INAS command. The command is case insensitive.

Examples
INAS -help
Returns the possible INAS commands in plain text format.

INAS Test1 -HELP
Returns the description of the Test1 Module.

INAS Test1 P -?
Returns the description of the keyword P of module Test1

INAS EXEC -HELP
Returns the description of general keyword EXEC.

LIST

Syntax
INAS LIST

Description
This command returns a list of implementend modules.

Properties
The command is case insensitive.

Example
INAS list
This command returns a list of implementend modules.

STATUS

Syntax
INAS STATUS [MODULE|ENTRY] [WAIT]

Description
This command returns the current status of jobs submitted by Portable INAS for the user. [MODULE|ENTRY] is optional and represents a specific name of a module or the jobentry identification as specified by the INAS command MODULE. [WAIT] is optional and indicates that the command should not return before [MODULE|ENTRY] is ready.

Properties
If [MODULE|ENTRY] and [WAIT] are omitted the status of all modules submitted by the user are returned promptly:
MODULE:ENTRY X
MODULE is the type of the module. ENTRY is the job entry identification or name of the job. X is the status of the job as described below.

If [MODULE|ENTRY] is omitted the status of all modules submitted by the user are returned after all modules are ready. If [WAIT] is omitted the status of [MODULE|ENTRY] submitted by the user is returned promptly. The command is case insensitive.

Returned value
The following symbols can be returned:
Q
The module has been queued, but was not yet processed.

P
The module has been submitted and is pending for execution.

R
The module is running.

I
The requested module is inactive.

E
Error occured during retrieval of status of requested module.

Examples
INAS STATUS
Returns the status of all modules submitted by the user.

INAS STATUS Test1 wait
Returns the status of module Test1 after it reached the inactive status.

INAS STATUS job123 wait
Returns the status of job with jobentry identification job123 after it reached the inactive status.

MODULE

Syntax
INAS MODULE [TREE]

Description
This command submits the module with name MODULE to the queuing system with keywords specified by [TREE] and returns the jobentry identification.

Properties
The name MODULE is case insensitive.

Example
INAS Test1 P=1
This command submits the module Test1, setting the value of keyword P to 1 first and returns the jobentry identification.

QUEUES

Syntax
INAS QUEUES [FREE]

Description
This command returns a list of available queues. [FREE] is optional and indicates that the command should only return queues that are idle. See also general keyword QUEUE.

Properties
If [FREE] is omitted all available queues are listed. The command is case insensitive.

Examples
INAS QUEUES
Returns a list of all available queues.

INAS Queues free
Returns a list of idle queues.

MANUAL

Syntax
INAS MANUAL

Description
This command returns the complete manual of the Portable INAS system.

Properties
The command is case insensitive.

Examples
INAS manual
Returns the manual in plain text format.

Back to contents


Modules

AIM

Description
Module for master library format conversion (bcd <--> bin).

Keywords
Special keywords for AIM are target, ampx_master_bin and ampx_master_bcd.
target
Obligatory; two values can be assigned: bin or bcd.
taget=bin: bcd library is conversed to bin library.

taget=bcd: bin library is conversed to bcd library.

ampx_master_bin
Binary ampx master library (unit 01); obligatory; no default value; default extention is .wrk

ampx_master_bcd
Bcd ampx master library (unit 18); obligatory; no default value; default extention is .bcd

AJAX

Description
Module for selecting and merging ampx master libraries.

Keywords
Special keywords for AJAX are INP1, INP2, INP3, INP4 and OUTP.
INP1
Filename (unit 20). optional; default value eij2_xmas.bin; default extention .bin

INP2
Filename (unit 21). optional; default extention .bin; no default value.

INP3
Filename (unit 22). optional; default extention .bin; no default value.

INP4
Filename (unit 23). optional; default extention .bin; no default value.

OUTP
Filename (unit 01). obligatory; default extention .dat; no default value.

ALE

Description
Module for Listing of ampx master/work/weight lib

Keywords
Special keywords for ALE are ampx_master_lib and ampx_working_lib.
ampx_master_lib
Ampx master library (unit 01). optional; default value eij2_xmas.bin; default extention .bin

ampx_working_lib
Ampx working library (unit 02). optional; no default value; default extention .wrk

AWL

Description
Module for conversion of ampx work/weight to/from bcd

Keywords
Special keywords for AWL are target, ampx_bin and ampx_bcd.
target
Obligatory; two values can be assigned: bin or bcd.
taget=bin: bcd library is conversed to bin library.

taget=bcd: bin library is conversed to bcd library.

ampx_bin
Binary Ampx work/weight library (unit 10). obligatory; no default value; default extention .wrk

ampx_bcd
Bcd Ampx work/weight library (unit 20). obligatory; no default value; default extention .bcd

BONAMI

Description
Bondarenko resonance shielding.

Keywords
Special keywords for BONAMI are master_lib_in and master_lib_out.
master_lib_in
Input master cross section library (unit 23). optional; default value eij2_xmas.bin; default extention .bin

master_lib_out
Output master cross section library (unit 22). optional; no default value; default extention .dat

COMPOZ

Description
Creates standard composition library.

Keywords
Special keyword for COMPOZ is stdcmp_lib.
stdcmp_lib
Standard composition library (unit 89)

CRSRD

Description
Conversion of AMPX WORKING LIB to MCNP type1 lib.

Keywords
Special keywords for CRSRD are XSIN, XSDR and TYP1.
XSIN
no default value; default extention .wrk

XSDR
optional; default value xsdir.dat; default extention .dat

TYP1
optional; default value type1.dat; default extention .dat

COUPLE

Description
?

Keywords
Special keywords for COUPLE are INPL, OUTP, WORK, BCDL, BCDD, PHOL and BCDC.
INPL
Filename (unit 29); input binary ORIGEN-S lib (mas/wor); optional; default value origens_22.bin; default extention .bin

OUTP
Filename
unit 31
output (updated) master library

unit 32
output ORIGEN-S working library

unit 35
alternate output lib (conversion)

optional; default value orslib.bin; default extention .bin

WORK
file_name (AMPX/XSDRN working library) (unit 3) optional; default extention .bin

BCDL
BCD_lib (units 51-53); optional; default extention .dat

BCDD
BCD_decay_lib (unit 27); optional; default value orsdec42.dat; default extention .dat

PHOL
photon_lib (units 54-56); optional; default extention .dat

BCDC
BCD_crs_lib (unit 28); optional; default value orscrs42.dat. default extention .dat

CSAS

Description
Criticality sequence control module.

Keywords
Special keyword for CSAS are

MAST, WORK, WEIG, COMP, ISOT.

MAST
ampx_master_lib (units 70,81-88). optional; default value eij2_xmas.bin; default extension .mas

WORK
ampx_working_lib; NITAWL OUT-WORK LIB (unit 4); optional; no default value; default extension .wrk

WEIG
ampx_weighted_lib; XSDRN OUT-WEIGHTED LIB (unit 3); optional; no default value; default extension .wgh

COMP
std_comp_file (unit 89); STD. COMP. LIB. optional; default value compoz2.bin; default extension .bin

ISOT
isotxs_file (unit 20); XSDRN ISOTXS output; optional; no default value; default extension .isotxs

DCMC

Description
Monte carlo calculation of Dancoff factor for infinite lattices.

DCMC3Q

Description
Monte carlo calculation of Dancoff factor for quasi-regular lattices.

ICE

Description
Module for mixing data on a ampx work/weight to macroscopic lib

Keywords
Special keywords for ICE are working_lib_in, working_lib_out, AN07, AN20, AN21 and KENO.
working_lib_in
Input working cross section library (unit 4); obligatory; no default value; default extention .wrk

working_lib_out
Output working cross section library (unit 3); obligatory; no default value; default extention .wrk

AN07
ANISN_lib punch (unit 7); optional; no default value; default extention .pun

AN20
ANISN_lib (unit 20); optional; no default value; default extention .an20

AN21
ANISN_lib (unit 21); optional; no default value; default extention .an21

KENO
KENO_lib (unit 14); optional; no default value; default extention .keno

K5TOK6

Description
Module for conversion of KENOVa to KENOVI input

Keywords
Special keywords for K5TOK6 are KEN6 and ampx_work_lib.
KEN6
kenovi_input (unit 7). obligatory; no default value; default extention .in6

ampx_work_lib
Working cross section library (unit 41). obligatory; no default value; default extention .wrk

KENOVA

Description
3-D Monte carlo neutron transport code

Keywords
Special keyword for KENOVA are stdcmp_lib and ampx_master_bcd.
stdcmp_lib
Standard composition library (unit 89)

ampx_master_bcd
Bcd Ampx master library

KENOVI

Description
3-D Monte carlo neutron transport code

Keywords
Special keyword for KENOVI are stdcmp_lib and ampx_master_bcd.
stdcmp_lib
Standard composition library (unit 89)

ampx_master_bcd
Bcd Ampx master library

LAVA

Description
Module for conversion of anisn lib to ampx working lib

Keywords
Special keywords for LAVA are working_lib_in and ANIS.
working_lib_in
Input working cross section library (unit 4); obligatory; no default value; default extention .wrk

ANIS
Anisn lib (unit 20). obligatory; no default value; default extention .dat

MALOCS

Description
Condensation ampx master library

Keywords
Special keyword for KENOVI are MASI and MASO.
MASI
input_ampx_master_lib (unit 1); obligatory; default extension .dat

MASO
output_ampx_master_lib (unit 22); optional; default extension .dat

MCNP4C3

Description
Monte carlo neutron-photon-electron transport code.

Keywords
Special keywords for MCNP4C3 are nodes and ppn. If both are omitted the module runs in the scalair mode. If one is defined the module will run in the parallel mode if the computer system supports it.
nodes
Number of nodes to be used for PVM. Default value 1.

ppn
Number of processors per node to be used for PVM. Default value 2.

FATAL
No value can be assigned. It is directly passed to MNCP. uitleg FATAL

CONT
No value can be assigned. It is directly passed to MNCP. uitleg CONT

CNTN
No value can be assigned. It is directly passed to MNCP. uitleg CNTN

LIB
Values assigned can be: MOST, ENDF6 or JEFECN. Default value is ENDF6.

XSDR
XS_directory_file; default extension .dat

XSLB
XS_data_file; default extension .dat

RUNT
runtpe_data_file; default extension .runtpe; if filename allready exists it will be renamed to filename_old.

SRCT
srctp_data_file; default extension .srctp; if filename allready exists it will be renamed to filename_old.

WSSA
write_source_file; default extension .wssa

RSSA
read_source_file; default extension .rssa

WXXA
wxxa_data_file; default extension .wxxa

PTRA
ptrac_data_file; default extension .ptra

WWIN
weight_window_inp; default extension .wwin

WWOU
weight_window_out; default extension .wwou

PVM
PVM is implemented on system klftcs01. Default queue used is iri1. Default path of executable PVM file is $HOME/pvm3/bin/LINUXI386/mcnp4c3.pvm. More information on PVM: http://www.csm.ornl.gov/pvm/pvm_home.html.

MORSE

Description
Multigroup Monte Carlo

Keywords
Special keyword for MORSE is WORK.
WORK
working_lib; AMPX working library (unit 21); optional; default extension .wrk

NITAWL

Description
Generate working library/Nordheim resonance shielding

Keywords
Special keywords for NITAWL are MAST, MST2, MST3 and WORK.
MAST
Input master cross section library (unit 01); optional; default value eij2_xmas.bin; default extention .bin; default directory LIBDIR/scale_libs

MST2
Previously prepared master cross section library (unit 02); optional; no default value; default extention .bin; default directory IODIR

MST3
Previously prepared master cross section library (unit 03); optional; no default value; default extention .bin; default directory IODIR

WORK
Output working library (unit 04); optional; no default value; default extention .wrk

NJOY99

Description
Cross section processing

Keywords
Special keywords for NJOY99 are INPT, INP2, INP3, THSC, GAMI, OUTP, OUTT, OUTG, OUTC and PLTF.
INPT
ENDF_neutron_input_file (unit 40); optional; no default value; default extention .dat

INP2
second_input_file (unit 41); optional; no default value; default extention .dat

INP3
third_input_file (unit 42); optional; no default value; default extention .dat

THSC
ENDF_thermal_scat_input_file (unit 45); optional; no default value; default extention .dat

GAMI
ENDF_photon_input_file (unit 50); optional; no default value; default extention .dat

OUTP
output_neutron_files (units 30, 31, 32; GROUPR, ACER, XSDIR), extentions .dat, .ace, .acd; optional

OUTT
output_temperature_file (unit 35); optional; default extention .grt

OUTG
output_photon_file (unit 36); optional; default extention .grg

OUTC
output_CCCC_file (unit 37); optional; default extention .ccr

PLTF
output_plot_file (unit 77); optional; no default value; default extension .ps

NSLINK42

Description
Generates a single master library by merging data for n-n, n-g, and g-g.

Keywords
Special keywords for NSLINK42 are endf_data, genn, gent, geng and master_lib_out.
endf_data
Endf data filename (unit 20); optional; no default value; default extention .dat

genn
Gendf neutron filename (unit 21); optional; no default value; default extention .dat

gent
Gendf temperature filename (unit 22); optional; no default value; default extention .dat

geng
Gendf gamma filename (unit 23); optional; no default value; default extention .dat

master_lib_out
Output master cross section library (unit 24); obligatory; no default value; default extention .dat

ORIGEN

Description
?.

Keywords
CONC
file_name (unit 71); optional; default extention .con

BINL
file_name (bin origen) (units 30-40); optional; default value origens_22.bin; default extention .bin

BCDL
BCD_lib (units 51-53); optional; default extention .dat

BCDD
BCD_decay_lib (unit 27); optional; default value orsdec42.dat; default extention .dat

PHOL
photon_lib (units 54-56); optional; default extention is .dat

BCDC
BCD_crs_lib (unit 28); optional; default value orscrs42.dat. default extention .dat

RADE

Description
Module for checking of ampx master lib

Keywords
Special keyword for RADE is ampx_master_lib.
ampx_master_lib
Ampx master library (unit 01). obligatory; no default value; default extention .dat

SCALE44A

Description
Code system driver

WAX

Description
?...

Keywords
Special keywords for WAX are INP1, INP2, INP3, INP4, INP5 and OUTP.
INP1
Filename (unit 21); obligatory; no default value; default extention .wrk

INP2
Filename (unit 22); optional; no default value; default extention .wrk

INP3
Filename (unit 23); optional; no default value; default extention .wrk

INP4
Filename (unit 24); optional; no default value; default extention .wrk

INP5
Filename (unit 25); optional; no default value; default extention .wrk

OUTP
Filename (unit 1); obligatory; no default value; default extention .wrk

XSDRNPM

Description
One dimensional discrete-ordinates transport code

Keywords
Special keywords for XSDRNPM are WORK, WEIG, PUNC, BALA, ANGU, ACTI, RESW, RESR, ISOT, flux_sca, input_dump, activities and bal_tables
WORK
ampx_working_lib (unit 4); obligatory; no default value; default extention .wrk

WEIG
ampx_weighted_lib (unit 3); optional; no default value; default extention .wgh

PUNC
punch_output_file (unit 7); optional; no default value; default extention .pun

BALA
neutron_balance_output (unit 14); optional; no default value; default extention .bal

ANGU
angular_flux (unit 16); optional; no default value; default extention .ang

ACTI
activity_output_file (unit 12); optional; no default value; default extention .act

RESW
write_restart_file (unit 25); optional; no default value; default extention .res

RESR
read_restart_file (unit 29); optional; no default value; default extention .res

ISOT
isotxs/anisn_cross_section_file (unit 20); optional; no default value; default extention .isotxs

flux_sca
Scalar fluxes (unit 17); optional; no default value; default extention

input_dump
Dump of input and derived data (unit 73); optional; no default value; default extention

ENV

Description
This code returns all environment variables of the shell.

Keywords
Hier volgen de Keywords
keyword1
Beschrijving van keyword1

keyword2
Beschrijving van keyword2

more
Nog meer gegevens

Back to contents


General Keywords

Portable INAS provides several general keywords, which are used by all modules. If they are omitted a default value is used.

IODIR=path

Description
This keyword enables control over the directory the module gets its input and puts its output. If IODIR is omitted the users directory is used. path should be a relative directory to the users directory or an absolute directory with reference to the root.

Properties
IODIR is case insensitive. path is case sensitive.

Example
IODIR=../Test1
This keyword results in change of the input and output directory to the subdirecty Test1 of the users directory.

IODIR=Test1
This keyword results in change of the input and output directory to the subdirecty Test1 of the users directory.

IODIR=/Test1
This keyword results in change of the input and output directory to the directy Test1 of the root directory.

INPUT=file

Description
This keyword enables control over the input filename of the module. If INPUT is omitted the standard input filename of the module is used. file should be a file in the user directory or in the directory specified by the IODIR keyword or include an absolute path. If the extension is omitted Portable INAS searches for the file file, file.inp or file.input. If keyword OUTPUT is omitted in the Portable INAS command this keyword also determines the name of the output file: file.out or file.output. If keyword LOG is omitted in the Portable INAS command this keyword also determines the name of the log file: file.log (Only if keyword LOGLEVEL is set to a value larger than 1). See also keywords IODIR, OUTPUT, LOG and LOGLEVEL.

Properties
INPUT is case insensitive. file is case sensitive.

Examples
INPUT=Test1.inp
This keyword results in input filename Test1.inp, output filename Test1.out and log filename Test1.log.

INPUT=Test1.input
This keyword results in input filename Test1.input, output filename Test1.output and log filename Test1.log.

INPUT=Test1
This keyword results in input filename Test1, output filename Test1.out and log filename Test1.log.

OUTPUT=file

Description
This keyword enables control over the output filename of the module. If OUTPUT is omitted the standard output filename of the module is used or the name determined by the INPUT keyword. If file includes an absolute path it will be created there, else file will be a created in the user directory or in the directory specified by the IODIR keyword. If the extension is omitted Portable INAS created the file file.out or file.output, depending on the extension of the input filename. See also keywords IODIR and INPUT.

IF file already exists, a new version will be created. The name of this new version will contain a sequence _xxxx. If file already had a sequence _yyyy the new sequence will be generated such that xxxx is the first free number larger than yyyy. If file did not have a sequence _yyyy then xxxx will be the first free number larger than 0.

Properties
OUTPUT is case insensitive. file is case sensitive.

Examples
OUTPUT=Test1.out
This keyword results in output filename Test1.out.

OUTPUT=Test1.dat
This keyword results in output filename Test1.dat.

OUTPUT=Test1
This keyword results in output filename Test1.ext, where ext is determined by the INPUT keyword.

LIBDIR=path

Description
This keyword enables control over the library pathname of the module. If LIBDIR is omitted the standard library pathname is used. path should be in the user directory or in the directory specified by the IODIR keyword or an absolute path. See also keyword IODIR.

Properties
LIBDIR is case insensitive. path is case sensitive.

Example
LIBDIR=Test1
This keyword results in library directory Test1.

LOG=file

Description
This key determines if a logfile should be created. file is the name of the logfile. If this keyword and keyword LOGLEVEL is omitted no logfile is created. See also keywords LOGLEVEL and INPUT.

Properties
file is case sensitive. LOG is case insensitive. If file is omitted and the keyword INPUT is not used in the Portabel INAS command, the default filename is used: INAS.LOG. If the extention is omitted, the extension .LOG will be used. If the filename already exsists, the new file will be appended.

Example
LOG=Test1.LOG
This keyword results in a logfile in the current directory with name Test1.LOG.

LOGLEVEL=x

Description
This key determines the level of information which is logged in the logfile. x can have the following values:
  1. No information is logged.

  2. Only information about the execution of the module is logged.

  3. Information about the execution of the module and the submit handling are logged.

  4. Information about the execution of the module, the submit handling and the submit preparations are logged.

  5. Information about the execution of the module, the submit handling and the submit preparations are logged. Further the information about the performance of the submitted job is logged in a seperate file MODULENAME.jobout

If x is omitted or has any other value this keyword is ignored. See also keyword LOG.

Properties
If this keyword is omitted, the default LOGLEVEL is 1. LOGLEVEL is case insensitive.

Example
LOGLEVEL=2
This keyword results in logging of all relevant information to level 2.

KEEP

Description
This key prevents the deletion of the scracth files and temporary directory used by the module.

Special for PBS: If information in a temporary directory should be kept and job is submitted to an unknown host the information after completion of the job is copied to the local temporary directory. The #PBS -W stageout command takes care of this after completion of the job. This command copies the contents of the temporary directory on the execution host to the temporary directory on the submitting host. This local temporary directory is created before the job is submitted. The temporary directory on the execution host can not be deleted. This can give interference during the exectution of the next job (with of without the keep command) of the same module and user. This is shown in the LOGFILE if LOGLEVEL 3 or higher is choosen.

Properties
If this keyword is omitted, the scratch files and the temporary directories are deleted. KEEP is case insensitive.

Example
KEEP
This keyword prevents the deletion of scratch files in the temporary directory.

EXEC=\path\file

Description
This key determines the path and filename of the executable source of the module. If \path\ is omitted the file will be looked for in the user directory. file.log is the default name of the logfile. If this keyword is omitted, the standard filename is used.

Properties
\path\file is case sensitive. EXEC is case insensitive. \path\ can be an absolute or relative directory description, comparable to keyword IODIR.

Example
EXEC=Test1
This keyword results in execution of the program Test1 in the user directory. The logfile will get the name Test1.log.

QUEUE=name

Description
This keyword defines the queue of the queuing system the module wil lbe submitted to. If QUEUE is omitted the batch is used. name should be a valid queue name of the queuing system. See also Portable INAS command QUEUES.

Properties
QUEUE is case insensitive. name is case sensitive.

Example
QUEUE=FAST_QUEUE
This keyword results in submitting of the module to system queue with name FAST_QUEUE.

WAIT

Description
If this keyword is added the INAS command will return after the submitted module is finished.

Properties
WAIT is case insensitive.

Example
INAS Test1 WAIT
This commands results in execution of the module Test1 and return of the command after completion.

Back to contents


Version and copyright

Version
Version 1.0 created on December 19, 2002 by V.O. de Haan updated on April 13, 2004 by V.O. de Haan

Copyright
(c) 2002-2004 BonPhysics R&I B.V.

Contact information
BonPhysics BV, P.O. Box 5629, 3297 ZG, Puttershoek, ++31 78 6767023

Back to contents

 Portable INAS