Table of Contents ECSS Model Page
Background Information Using the SPENVIS system
Output files

A list of all the output files produced by SPENVIS is given in the table below. The file names of the outputs of SPENVIS are spenvis_xxx.html for report files and spenvis_xxx.txt for data files (with a few exceptions). In the first column, the files are listed alphabetically by the three character label xxx). The second column contains a short description of the file contents, the third column identifies the model or tool that produces or modifies the file, and the fourth column lists the models or tools that use the file as input. Clicking on a file name extension will bring up a description of the file formats.

The output files can be downloaded via the directory listing in the results page for each model.

List of files generated by SPENVIS
Ext. Description Created by Used by
apo Atmospheric densities and temperatures Atmosphere and ionosphere models Plotting routines
app Report Atmosphere and ionosphere models None
ato Atmospheric density, flux and fluence ATOMOX Tool Plotting routines
atp Report ATOMOX Tool None
att Spacecraft attitude vectors Orbit generator Proton anisotropy models, atmosphere and ionosphere models, plotting routines
blo Magnetic field strength and vector components, ancillary parameters Magnetic field models Plotting routines
blp Report Magnetic field models None
bpo Magnetic field vectors and vector components, ancillary parameters Magnetic field models Plotting routines
bpp Report Magnetic field models None
cto Coordinate transformation parameters Coordinate transformation tool Plotting routines
ctp Report file Coordinate transformation tool None
dio Fluxes, electric field and voltage Spacecraft internal charging analysis tool (DICTAT) Plotting routines
dip Report Spacecraft internal charging analysis tool (DICTAT) None
dso Magnetic drift shell coordinates Drift shell tool Plotting routines
dsp Report Drif shell tool None
dss Magnetic drift shell summary Drift shell tool Plotting routines
efo Damage equivalent fluences Solar cell equivalent fluence model (EQFLUX) Plotting routines
efp Report Solar cell equivalent fluence model (EQFLUX) None
epo Fluxes and currents Spacecraft surface charging analysis tool (EQUIPOT) Plotting routines
epp Report Spacecraft surface charging analysis tool (EQUIPOT) None
gem.g4mac Geant4 macro file Geant4-based Microdosimetry Analysis Tool (GEMAT) Geant4-based Microdosimetry Analysis Tool (GEMAT)
geo Fluence and PHS Geant4-based Microdosimetry Analysis Tool (GEMAT) plotting routines
gep Report Geant4-based Microdosimetry Analysis Tool (GEMAT) None
ger Log file Geant4-based Microdosimetry Analysis Tool (GEMAT) None
gro Meteoroid fluxes Grün meteoroid model Plotting routines
grp Report Grün meteoroid model None
ilo Illumination and irradiances Satellite illumination Plotting routines
ilp Report Satellite illumination None
leo Low Earth and polar orbital environment parameters Spacecraft charging environment tool (LEOPOLD) Plotting routines
lep Report Spacecraft charging environment tool (LEOPOLD) None
lof Segment and mission averaged proton and ion energy spectra and ion LET spectra LET Model SEU rate model, plotting routines
loo Proton energy and ion LET spectra along a spacecraft orbit LET Model SEU rate model
lop Report Proton energy and ion LET spectra model None
mlo Fluence, NIEL, dose or PHS Multi-layered shielding simulation analysis tool (Mulassis) plotting routines
mlp Report Multi-layered shielding simulation analysis tool (Mulassis) None
mlr Log file Multi-layered shielding simulation analysis tool (Mulassis) None
mul.g4mac Geant4 macro file Multi-layered shielding simulation analysis tool (Mulassis) Multi-layered shielding simulation analysis tool (Mulassis)
nao Debris fluxes NASA90 Debris model Plotting routines
nap Report NASA90 Debris model None
nio Damage curves and shielded spectra NIEL Damage model Plotting routines
nip Report NIEL Damage model None
pos Coordinate grid Coordinate grid generator Trapped radiation models, magnetic field models, atmosphere and ionosphere models, plotting routines
rco Omnidirectional RDCs RDC converter tool Solar cell equivalent fluence model
rcp Report file RDC converter tool None
saoSpacecraft orbit Orbit generator Trapped radiation models, solar proton models, ion energy and LET spectra, atmosphere and ionosphere models, magnetic field models, plotting routines
sap Report Orbit generator None
s2o Dose curves Ionising dose model (SHIELDOSE-2) Plotting routines
s2p Report Ionising dose model (SHIELDOSE-2) None
sec.gdml GDML file Geometry definition tool Sector Shielding Analysis Tool (SSAT)
sef Solar proton spectra Solar proton models Ionising dose models (SHIELDOSE, SHIELDOSE-2), NIEL model, solar cell damage equivalent model (EQFLUX), plotting routines
seo Solar proton attenuation file Solar proton models Plotting routines
sep Report Solar proton models None
sho Dose curves Ionising dose model (SHIELDOSE) Plotting routines
shp Report Ionising dose model (SHIELDOSE) None
soo V/I Characteristics, erosion rates, current collection models, grounding configuration Solar array/spacecraft interaction analysis program (SOLARC) Plotting routines
sopReport Solar array/spacecraft interaction analysis program (SOLARC) None
spe Trapped electron spectra along a spacecraft orbit Trapped radiation models Plotting routines
spp Trapped proton spectra along a spacecraft orbit Trapped radiation models Proton anisotropy models, ion energy and LET spectra, plotting routines
ssa.g4mac Geant4 macro file Sector Shielding Analysis Tool (SSAT) Sector Shielding Analysis Tool (SSAT)
ssa.gdml GDML file Geometry definition tool or user upload Sector Shielding Analysis Tool (SSAT)
sso Shielding distributions Sector Shielding Analysis Tool (SSAT) Ionising dose models (SHIELDOSE, SHIELDOSE-2), NIEL model, plotting routines
ssp Report Sector Shielding Analysis Tool (SSAT) None
stp Report Geometry definition tool None
tbo Trapped particles and ancillary coordinates Positional (magnetic) trapped particle models Plotting routines
tbp Report Positional (magnetic) trapped particle models None
tpo Trapped particle fluxes and ancillary coordinates Positional (geographic) trapped particle models Plotting routines
tpp Report Positional (geographic) trapped particle models None
tri Trapped radiation spectra Trapped radiation models Ionising dose models (SHIELDOSE, SHIELDOSE-2), NIEL model, solar cell damage equivalent model (EQFLUX), plotting routines
trp Report Trapped radiation models None
uof Experimental cross sections and Bendel function fit SEU rate model Plotting routines
uoo SEU rates along a spacecraft orbit SEU rate model Plotting routines
uop Report SEU rate model None

Record structure of the magnetic shell tool file. All records are in free format.
RecordDescription
Header Records
1Project descriptor
2Number of columns N, 0,number of field lines Nf, 1, 0
3--(N+2)Titles of columns
Data Records
1Number of points on field line Np
2--(Np+1)Description of point
...Nf Repetitions of records 1--(Np+1)

Record structure of the magnetic shell summary file. All records are in free format.
RecordDescription
Header Records
1Project descriptor
2Number of columns N, 0,number of field lines Nf, 1, 0
3--(N+2)Titles of columns
Data Records
1--NfDescription of field line

Old generic record structure of output files. All records are in free format.
RecordDescription
Header Records
1Project descriptor
2Number of data columns, column number of independent variable, number of points in the grid N
3--M+2Column headers
Data Records
1--NM Data columns
N+1Blank line

Record structure of the ion energy and LET spectrum file. N is the number of points on the trajectory. All records are in free format.
RecordDescription
Header Records
1Project descriptor
2 Number of proton energies Np, number of LET values NLET. The number of spectra per orbital point, Ns, is 3 if Np>0, 2 otherwise.
3 - 5 Description labels and energies for the differential proton spectra (absent if Np=0)
3 - 6 or 6 - 9 (if Np>0) Description labels and LET values for the LET spectra (integral and differential)
7 or 10 (if Np>0) Mission segment header
Data Records
1 - NsN N repetitions of the differential proton spectra (if Np>0) and the integral and differential LET spectra
NsN+1 - Ns(N+1) Sentinel records (-1.0) signifying the end of the orbit

Record structure of the SOLARC output file. All records are in free format.
RecordDescription
1Project descriptor
2Number of negative and positive interconnects (total: Nc)
3--4Axis labels for V/I characteristics
5--4+NcInterconnect voltages and currents
5+NcBlank line
6+NcNumber of points in erosion rate plots for first (Ne1) and second (Ne2) material
7+Nc--8+Nc Axis labels for erosion rates
9+NcFirst material symbol
10+Nc--10+Nc+Ne1 Interconnect voltages and erosion rates for first material
11+Nc+Ne1Second material symbol
12+Nc+Ne1--12+Nc+Ne1+Ne2 Interconnect voltages and erosion rates for second material
13+Nc+Ne1+Ne2 Blank line
14+Nc+Ne1+Ne2--16+Nc+Ne1+Ne2 Plot labels for current collection models
17+Nc+Ne1+Ne2 Current collection model numbers for array and structure
18+Nc+Ne1+Ne2 Blank line
19+Nc+Ne1+Ne2 Maximum negative and positive voltage
20+Nc+Ne1+Ne2 Flag for inclusion of structure, index of interconnect, number of interconnects, structure voltage
21+Nc+Ne1+Ne2 Blank line

Record structure of the output file generated for the positional (magnetic) trapped particle models. All records are in free format.
RecordDescription
Header Records
1Project descriptor
2Number of data columns M, column number of independent variable, number of points in the grid N
3--M+2Column headers
M+3Number of energies in the energy spectra
M+4Energies (MeV)
M+5Generic header for the energy spectra
Data Records
1--NM Data columns
N+1Blank line

Record structure of the output file generated for the omnidirectional RDCs. All records are in free format.
LineDescription
Header Lines
1Cell name
5Values of the proton-electron damage equivalence factors for Pmax (mW), Voc (mV) and Isc (mA)
Data lines
7-10Electron block, header lines
12-5810 values per line: electron energy (MeV), ''norm'', RDCs for 0, 1, 3, 6, 12, 20, 30, 60 coverglass thickness (in mils)
60-63Proton Pmax block, header lines
65-12910 values per line: proton energy (MeV), ''norm'', Pmax RDCs for 0, 1, 3, 6, 12, 20, 30, 60 coverglass thickness (in mils)
131-134Proton Voc block, header lines
136-20010 values per line: proton energy (MeV), ''norm'', Voc RDCs for 0, 1, 3, 6, 12, 20, 30, 60 coverglass thickness (in mils)
202-205Proton Isc block, header lines
207-27110 values per line: proton energy (MeV), ''norm'', Isc RDCs for 0, 1, 3, 6, 12, 20, 30, 60 coverglass thickness (in mils)

Record structure of the new file format.
A detailed description is given at the bottom of this page.
RecordFormatDescription
Header Records
1 '*',8(',',I) Total number of header records Nh (including current one), number of comment lines Nc, number of metavariable lines Nm, number of annotation lines Na, number of variable lines Nv, number of data columns Nd, number of data lines Nl (-1 if unknown), number of blocks Nb following the current block
2--Nc+1 string in single quotes comment lines
Nc+2--Nc+Nm+1 variable name, dimension (negative for strings, positive for floats), values metavariable definitions
Nc+Nm+2-- Nc+Nm+Na+1 string in single quotes annotation lines
Nc+Nm+Na+2-- Nc+Nm+Na+Nv+1 variable name, dimension, values variable definitions
Data Records
1--Nl comma separated floats Nc data columns
Nl+1 string in single quotes end of block or file indicator

General description of the tabular output format

This section describes the general features of the new format for the UNIRAD/SPENVIS output tables. It includes the file specifications and the internal organisation of the data. The format specifications are such that the tabular outputs can be: The specifications on the content of each tabular output are not included in this section.

File specifications

The UNIRAD/SPENVIS tabular outputs are sequentially organised files consisting of variable-length records whose length is indicated by an explicit terminator embedded in the data. The record terminator is the 2-character sequence consisting of a carriage-return and a line-feed (ASCII codes 13 and 10, respectively). Except for the 2-character terminator, the records only include readable ASCII characters with code between 32 and 127. Such files can be created by a FORTRAN program with the following statement:
      OPEN(UNIT=n, FILE='project.csv', FORM='FORMATTED', 
     :     ORGANIZATION='SEQUENTIAL', RECORDTYPE='STREAM')
where the text in italics depends on the user application.

Each record contains comma (,) separated values that can be read by a FORTRAN list-directed READ statement. The integer and floating values are represented by their decimal forms (e.g. 123, -98, 734.5, -3.2345E+10, +6.2345D+68), optionally preceded by white space characters (ASCII code 32). The character strings are delimited by apostrophes (') without other characters before or after the apostrophes. When an apostrophe has to be included in the character string, it is represented by two consecutive apostrophes.

Example

The use of the file specifications is illustrated by the following FORTRAN program.
      PROGRAM sample_1
C
      INTEGER      k1, k2
      REAL         r1, r2
      CHARACTER*32 s1
C
      DATA k1, k2, r1, r2/ -547, 12, -5.978E-18, 6371.2/
C
C     File creation
C
      OPEN(UNIT=1, FILE='sample_1.txt', FORM='FORMATTED', 
     :     ORGANIZATION='SEQUENTIAL', RECORDTYPE='STREAM')
      WRITE(1,1000) k1, r1, k2, r2
      CLOSE(1)
C
C     format
C
 1000 FORMAT( i6, 1h,, 1p, e13.6, 0p, 2h,', 
     :        'Text with an apostrophe:''''.', 2h',, i8, 1h,, f10.3)
C
C     File read
C
      OPEN(UNIT=1, FILE='sample_1.txt', STATUS='OLD')
      READ(1,*) k1, r1, s1, k2, r2
      CLOSE(1)
C
      PRINT*,k1
      PRINT*,r1
      PRINT*,s1
      PRINT*,k2
      PRINT*,r2
      END

Internal organisation

A UNIRAD/SPENVIS output file contains one or more independent parts, each being associated with a section of the corresponding UNIRAD/SPENVIS namelist. Note that, for some applications, more than one part can be associated to a single section of the namelist. Each part includes three sections: a header, a body, and a footer. The following sub-sections describe the general structure of these three sections.

The general structure is illustrated with the help of a sample file.

Header section

The records included in the header section contain general information on the data (project title, main parameters of the program used to generate the data,...), and a description of the content of the body section. The header section includes also a reserved area that can be extended for future usage. The following table gives a detailled description of the structure of the header section. Note that the number of records varies with the application.

Record Elements Description
1 '*',
nheader,
ntext,
nmeta,
nfut, nvar,
ncol,
nbody,
npart
The first record of the header section consists of a character string and eight integers. The character string serves as guard and shall always be set to a single asterisk ('*'). The integers provide the information on the size of the header and body sections:
  • nheader is the total number of records of the header section (including this record);
  • ntext is the number of text lines included in the first part of the header section;
  • nmeta is the number of metavariables;
  • nfut is the number of records added to the header section with a format specific to the application. In SPENVIS, this section is used for the annotation on PostScript graphical outputs;
  • nvar is the number of variables in the body section;
  • ncol is the number of columns in the body section. As variables can have more than one dimension, this number does not have to be equal to the number of columns;
  • nbody is the number of records in the body section (set to -1 when the length of the body section is unknown);
  • npart is the number of remaining blocks associated to the current namelist section.
Note that part of the information is redudant since nheader = 1 + ntext + nfutur + nmeta + nvar.
2 ... (ntext+1) atext Each record includes a single character string. These character strings can be used to indentify the program used to produce the file (e.g. 'SPENVIS v3.1 - ORBIT GENERATOR - OpenVMS (BIRA/IASB)'), the project title, or other information such as the name of the model used to produce the data.
(2+ntext)
... (1+ntext+nmeta)
ameta,
ktyp, val_1,
val_2, ...
Each record contains the information on a specific metavariable, and starts by a character string (ameta) followed by an integer (ktyp). The string ameta contains the name of the metavariable. The integer ktyp specifies the type of the metavariable. When ktyp is equal to -1, the metavariable contains a character string, the value of which is set in the third element of the record (val_1). When ktyp is greater than 0, the metavariable contains a vector of ktyp real numbers, the values of which are set in the third and following elements of the record (val_1 ... val_[ktyp]).
(2+ntext+nmeta)
... (nheader-nvar)
not defined This area is reserved for future extensions. SPENVIS uses this to write information about the annotation (position and content) used in the PostScript graphical outputs.
(nheader-nvar+1)
... nheader
aname,
aunit,
nelem,
atitle
Each record includes information on a specific variable of the data set. A variable is defined as a single real number or as a vector of real numbers. Each record contains four elements:
  • aname, a character string with the name of the variable;
  • aunit, a character string with the units of the variable;
  • nelem, an integer with the number of elements of the vector (set to 1 when the variable is a single real number);
  • atitle, a character string with a title for the variable that can be used on plots, etc...
Optionally, the string atitle can be followed by a set of character strings with metavariable names (see below).

Note that the sum over the nvar records of the nelem value shall be equal to ncol.

The header section is directly followed by the body section.

Future extensions

According to the above specification, the body can only include single real variables or one dimensional variables. In future developments, multi-dimensional variables could be introduced. In that case, nelem should correspond to the total number of elements and information on the dimensions can be added after the argument atitle. For instance: a list of metavariables, each one corresponding to one of the dimensions and containing as many elements as the corresponding dimension. A density map, e.g., could be stored in a variable defined as 'DENS','cm-3', 200,'Density','LATITUDE','LONGITUDE' where LATITUDE and LONGITUDE are metavariables which contain a set of 10 latitudes and 20 longitudes, respectively (10 x 20 = 200). In the SPENVIS system, this area is currently used to add annotation to plots produced in PostScript format.

Body section

Each record of the body section contains the values associated to all the variables of the data set. All records of the body section have the same structure: they contain a suite of real numbers, the number of which is specified by the 7th element of the first record of the header section (ncol). For the sake of clarity, the values are usually written in fields with fixed width such that the fields from the different records are aligned in columns. In each record, the values are ordered the same way as the descriptions in the header section.

The number of records contained in the body section is not explicitly determined. An expected value of this number is given by the 8th element of the first record of the header section (nbody).
Practically, the end of the body section is defined by the detection of the footer section.

Footer section

The footer section consists of a single record that contains a character string. This character string should not start with an asterix (*), as this is reserved for internal use, and is used to detect the end of the body section. The text of the footer string can be used to pass information on the next part of the output file. Note that both character strings *ERROR* and *CONTINUE* will be used by IDL and FORTRAN interface routines.

For the sake of uniformity the following character strings are suggested:

The usage of the header, body and footer sections are illustrated by a sample file.

Sample file

This example illustrates the specifications on the UNIRAD/SPENVIS output file structure. Different colors and record numbers have been added in order to better highlight the different parts of the structure, but do not occur in the file.

1:'*', 13, 2, 3, 4, 3, 8, -1, 0
2:'Title of this project'
3:'This is an example file'
4:'EPOCH', 1, 1995.0
5:'ENERGY', 6, 0.10, 0.50, 1.00, 2.00, 5.00, 10.00
6:'MODEL', -1,'IRI-90'
7:##########################
8:# Specific area reserved #
9:#     for future use     #
10:##########################
11:'AMJD ','day ', 1,'Modified Julian Day'
12:'FLUX_EL ','cm-2 s-1', 6,'Integral electron flux'
13:'L ','Re ', 1,'McIlwain''s shell parameter'
14: 17888.07465, 1.2E+06, 1.0E+06, 5.4E+05, 2.9E+05, 4.2E+04, 9.8E+03, 2.067
15: 17890.78901, 6.0E+05, 5.0E+05, 2.7E+05, 1.4E+05, 2.1E+04, 4.9E+03, 1.076
16: 17892.87572, 3.2E+05, 2.0E+05, 2.4E+05, 1.9E+05, 2.2E+04, 4.8E+03, 1.085
17: 17894.36543, 1.2E+04, 1.0E+04, 5.4E+03, 2.9E+03, 4.2E+02, 9.8E+01, 2.094
18: 17896.43453, 6.0E+05, 5.0E+05, 2.7E+05, 1.4E+05, 2.1E+04, 4.9E+03, 3.103
19: 17898.88785, 1.2E+06, 1.0E+06, 5.4E+05, 2.9E+05, 4.2E+04, 9.8E+03, 3.112
20: 17900.68776, 1.2E+04, 1.0E+04, 5.4E+03, 2.9E+03, 4.2E+02, 9.8E+01, 2.121
21: 17902.76786, 6.0E+05, 5.0E+05, 2.7E+05, 1.4E+05, 2.1E+04, 4.9E+03, 1.130
22:'End of Block'

Comments


IDL is a registered trademark of Research Systems Inc.
Microsoft is a registered trademark of Microsoft Corporation.

Last update: $LastChangedDate: 2010-03-01 09:16:56 +0100 (Mon, 01 Mar 2010) $