PENELOPE¶

Base classes¶

Definition of base classes.

class pypenelopetools.penelope.base.InputLineBase[source]¶

Bases: object

Base class to parse and read PENELOPE text files.

_abc_cache = <_weakrefset.WeakSet object>¶

_abc_negative_cache = <_weakrefset.WeakSet object>¶

_abc_negative_cache_version = 44¶

_abc_registry = <_weakrefset.WeakSet object>¶

_create_line(name, values, comment='')[source]¶

Creates an input line of this keyword from the specified text. The white space between the items is automatically adjusted to fit the line size. The keyword and the total length of the line is checked not to exceed their respective maximum size.

Parameters:	name (str) – 6-character keyword. values (tuple or list) – Values. comment (str, optional) – Comment associated with the line.
Returns:	Formatted line.
Return type:	str

_parse_line(line)[source]¶

Extracts the keyword, the values and the comment of an input line. The values are returned as a list.

Parameters:	line (str) – Input line.
Returns:	Keyword, values, comment.
Return type:	tuple(str, tuple(str), str)

_peek_next_line(fileobj)[source]¶

Returns the next line without advancing the current position.

Parameters:	fileobj (file object) – File object opened with read access.
Returns:	Next line, stripped of all trailing white spaces.
Return type:	str

_read_next_line(fileobj)[source]¶

Returns the next line and advances the current position. Comment line (line starting with 7 spaces) are automatically skipped.

Parameters:	fileobj (file object) – File object opened with read access.
Returns:	Next line, stripped of all trailing white spaces.
Return type:	str

read(fileobj)[source]¶

Reads a PENELOPE-type file.

Parameters:	fileobj (file object) – File object opened with read access.

write(fileobj)[source]¶

Writes to a PENELOPE-type file.

Parameters:	fileobj (file object) – File object opened with write access.

Definition of base keyword classes.

class pypenelopetools.penelope.keyword.KeywordBase[source]¶

Bases: pypenelopetools.penelope.base.InputLineBase

Base of all PENELOPE keywords.

copy()[source]¶

Returns:	Deep copy of this keyword.
Return type:	_KeyboardBase

get()[source]¶

Returns:	Value(s) of this keyword.
Return type:	tuple

name¶: str – Name of keyword.

class pypenelopetools.penelope.keyword.KeywordGroupBase[source]¶

Bases: pypenelopetools.penelope.keyword.KeywordBase

Group of keywords, keywords that should always be defined together.

copy()[source]¶: Returns: _KeyboardBase: Deep copy of this keyword.

get()[source]¶

Returns:	Value(s) of all keywords.
Return type:	tuple

get_keywords()[source]¶

Returns:	Keywords apart of this group.
Return type:	tuple

name¶: str – Name of keyword.

read(fileobj)[source]¶

Reads a PENELOPE-type file.

Parameters:	fileobj (file object) – File object opened with read access.

write(fileobj)[source]¶

Writes to a PENELOPE-type file.

Parameters:	fileobj (file object) – File object opened with write access.

class pypenelopetools.penelope.keyword.KeywordSequence(keyword, maxlength)[source]¶

Bases: pypenelopetools.penelope.keyword.KeywordBase

Sequence of keywords, keywords that can be defined multiple times.

Parameters:	keyword (KeywordBase) – Base keyword. maxlength (int) – Maximum number of keywords that can be added.

add(*args)[source]¶

Adds a new keyword definition. This internally creates a new keyword based on the base keyword, sets the value(s) and add it to a list.

Parameters:	*args – Value(s).

clear()[source]¶: Clears all added keywords.

copy()[source]¶: Returns: _KeyboardBase: Deep copy of this keyword.

get()[source]¶

Returns:	Value(s) of all keywords.
Return type:	tuple

name¶: str – Name of keyword.

pop(index)[source]¶

Removes a keyword.

Parameters:	index (int) – Index of the keyword to be removed.

read(fileobj)[source]¶

Reads a PENELOPE-type file.

Parameters:	fileobj (file object) – File object opened with read access.

write(fileobj)[source]¶

Writes to a PENELOPE-type file.

Parameters:	fileobj (file object) – File object opened with write access.

class pypenelopetools.penelope.keyword.TypeKeyword(name, types, comment='')[source]¶

Bases: pypenelopetools.penelope.keyword.KeywordBase

Keyword where the type of the values are checked.

Parameters:	name (str) – Name of keyword. types (tuple(type)) – Type of each value of the keyword. comment (str, optional) – Comment.

comment¶: str – Comment.

copy()[source]¶: Returns: _KeyboardBase: Deep copy of this keyword.

get()[source]¶: Returns: tuple: Value(s) of this keyword.

name¶: str – Name of keyword.

read(fileobj)[source]¶

Reads a PENELOPE-type file.

Parameters:	fileobj (file object) – File object opened with read access.

set(*args)[source]¶

Sets the value(s) of the keyword. Each value is checked if it matches the defined type.

Parameters:	*args – Value(s).
Raises:	`TypeError` – If one value does not match its defined type.

validate(*args)[source]¶

write(fileobj)[source]¶

Writes to a PENELOPE-type file.

Parameters:	fileobj (file object) – File object opened with write access.

Definition of base separator classes.

class pypenelopetools.penelope.separator.Separator(text, name='')[source]¶

Bases: pypenelopetools.penelope.base.InputLineBase

Base of all PENELOPE separators.

Parameters:	text (str) – Comment of the separator name (str, optional) – name of separator keyword (e.g. END)

text¶: str – Comment of the separator

name¶: str, optional – name of separator keyword (e.g. END)

read(fileobj)[source]¶

Reads a PENELOPE-type file.

Parameters:	fileobj (file object) – File object opened with read access.

write(fileobj)[source]¶

Writes to a PENELOPE-type file.

Parameters:	fileobj (file object) – File object opened with write access.

Definition of base input classes.

class pypenelopetools.penelope.input.PenelopeInputBase[source]¶

Bases: pypenelopetools.penelope.base.InputLineBase

Base input class.

get_keywords()[source]¶

Returns:	Sorted list of all keywords in the input.
Return type:	list

read(fileobj)[source]¶

Reads an input file (i.e. .in).

Parameters:	fileobj (file object) – File object opened with read access.

write(fileobj)[source]¶

Writes to an input file (i.e. .in).

Parameters:	fileobj (file object) – File object opened with write access.

Definition of base result classes.

class pypenelopetools.penelope.result.PenelopeResultBase[source]¶

Bases: object

Base class representing a type of result.

read(fileobj)[source]¶

Reads a result file.

Parameters:	fileobj (file object) – File object opened with read access.

read_directory(dirpath)[source]¶

Read a result file from a directory.

Parameters:	dirpath (str) – Path of a directory.

Keywords¶

Keywords used across different PENELOPE main programs.

class pypenelopetools.penelope.keywords.DSMAX(maxlength=5000)[source]¶

Bases: pypenelopetools.penelope.keyword.KeywordSequence

Maximum step length of electrons and positrons in body.

Note

This parameter is important only for thin bodies; it should be given a value of the order of one tenth of the body thickness or less.

add(kb, dsmax)[source]¶

Sets maximum step length.

Parameters:	kb (int) – Index of body. dsmax – Maximum step length in cm.

class pypenelopetools.penelope.keywords.DUMPP[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Dump interval.

When the DUMPTO option is activated, simulation results are written in the output files every DUMPP seconds. This option is useful to check the progress of long simulations. It also allows the program to be run with a long execution time and to be stopped when the required statistical uncertainty has been reached.

set(dumpp)[source]¶

Sets interval.

Parameters:	dumpp (int) – Dump interval in seconds.

class pypenelopetools.penelope.keywords.DUMPTO[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Name of dump file.

Generate a dump file named ‘dump2.dmp’ after completing the simulation run. This allows the simulation to be resumed later on to improve statistics.

Note

If the file ‘dump2.dmp’ already exists, it is overwritten.

set(filename)[source]¶

Sets filename.

Parameters:	filename (str) – File name of dump file (up to 20 characters).

class pypenelopetools.penelope.keywords.EABSB(maxlength=5000)[source]¶

Bases: pypenelopetools.penelope.keyword.KeywordSequence

Local absorption energies EABSB(KPAR,KB) of particles of type KPAR in body KB.

These values must be larger than EABS(KPAR,M), where M is the material of body KB. When the particle is moving within body KB, the absorption energy EABS(KPAR,M) is temporarily set equal to EABSB(KPAR,KB). Thus, the simulation of the particle history is discontinued when the energy becomes less than EABSB(KPAR,KB). This feature can be used, e.g., to reduce the simulation work in regions of lesser interest.

add(kb, eabs1, eabs2, eabs3)[source]¶

Sets local absorption energies.

Parameters:	kb (int) – Index of body. eabs1 (float) – Absorption energy of electrons in eV. eabs2 (float) – Absorption energy of photons in eV. eabs3 (float) – Absorption energy of positrons in eV.

class pypenelopetools.penelope.keywords.EDSPC[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Name of the output spectrum file.

set(filename)[source]¶

Sets filename.

Parameters:	filename (str) – File name of output spectrum file (up to 20 characters).

class pypenelopetools.penelope.keywords.ENDETC[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Definition of an energy-deposition detector.

set(el, eu, nbe)[source]¶

Sets energy limits.

Parameters:	el (float) – Lower limit in eV. eu (float) – Upper limit in eV. nbe (int) – Number of bins in the output energy distribution. Should be less than 1000. If NBE is positive, energy bins have uniform width, DE=(EU-EL)/NBE. When NBE is negative, the bin width increases geometrically with the energy, i.e., the energy bins have uniform width on a logarithmic scale.

class pypenelopetools.penelope.keywords.GEOMFN[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Name of geometry definition file.

The bodies in the material structure are normally identified by the sequential labels assigned by PENGEOM. For complex geometries, however, it may be more practical to employ user labels, i.e., the four-character strings that identify the body in the geometry definition file. In PENMAIN (and only in the parts of the code that follow the definition of the geometry), a body can be specified by giving either its PENGEOM numerical label or its user label enclosed in a pair of apostrophes (e.g., ‘BOD1’). However, bodies that result from the cloning of modules (as well as those defined in an INCLUDEd geometry file) do not have a user label and only the PENGEOM numerical label is acceptable.

set(filename)[source]¶

Sets filename.

Parameters:	filename (str) – File name of material file (up to 20 characters).

class pypenelopetools.penelope.keywords.GRIDX[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Definition of x-coordinates of the vertices of the dose box.

set(xl, xu, ndbx)[source]¶

Sets dimensions.

Parameters:	xl (float) – Lower limit of the dose box along the x-axis in cm. xu (float) – Upper limit of the dose box along the x-axis in cm. ndbx (int) – Number of bins (i.e. voxels) along the x-axis.

class pypenelopetools.penelope.keywords.GRIDY[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Definition of y-coordinates of the vertices of the dose box.

set(yl, yu, ndby)[source]¶

Sets dimensions.

Parameters:	yl (float) – Lower limit of the dose box along the y-axis in cm. yu (float) – Upper limit of the dose box along the y-axis in cm. ndby (int) – Number of bins (i.e. voxels) along the y-axis.

class pypenelopetools.penelope.keywords.GRIDZ[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Definition of z-coordinates of the vertices of the dose box.

set(zl, zu, ndbz)[source]¶

Sets dimensions.

Parameters:	zl (float) – Lower limit of the dose box along the z-axis in cm. zu (float) – Upper limit of the dose box along the z-axis in cm. ndbz (int) – Number of bins (i.e. voxels) along the z-axis.

class pypenelopetools.penelope.keywords.IBRSPL(maxlength=5000)[source]¶

Bases: pypenelopetools.penelope.keyword.KeywordSequence

Bremsstrahlung splitting for electrons and positrons.

Note

Note that bremsstrahlung splitting is applied in combination with interaction forcing and, consequently, it is activated only in those bodies where interaction forcing is active.

add(kb, ibrspl)[source]¶

Add Bremsstrahlung splitting.

Parameters:	kb (int) – Index of body. ibrspl (int) – Splitting factor.

class pypenelopetools.penelope.keywords.IXRSPL(maxlength=5000)[source]¶

Bases: pypenelopetools.penelope.keyword.KeywordSequence

Splitting of characteristic x rays emitted.

Each unsplit x ray with ILB(2)=2 (i.e., of the second generation) when extracted from the secondary stack is split into IXRSPL quanta. The new, lighter, quanta are assigned random directions distributed isotropically.

add(kb, ixrspl)[source]¶

Add characteristic x rays splitting.

Parameters:	kb (int) – Index of body. ixrspl (int) – Splitting factor.

class pypenelopetools.penelope.keywords.InteractionForcings(maxlength=120000)[source]¶

Bases: pypenelopetools.penelope.keyword.KeywordSequence

Forcing of interactions.

FORCER is the forcing factor, which must be larger than unity. WLOW and WHIG are the lower and upper limits of the pweight window where interaction forcing is applied. When several interaction mechanisms are forced in the same body, the effective weight window is set equal to the intersection of the windows for these mechanisms.

If the mean free path for real interactions of type ICOL is MFP, the program will simulate interactions of this type (real or forced) with an effective mean free path equal to MFP/FORCER.

Hint

A negative input value of FORCER, -FN, is assumed to mean that a particle with energy E=EPMAX should interact, on average, +FN times in the course of its slowing down to rest, for electrons and positrons, or along a mean free path, for photons. This is very useful, e.g., to generate x-ray spectra from bulk samples.

add(kb, kpar, icol, forcer, wlow, whig)[source]¶

Adds forcing for an interaction.

Parameters:	kb (int) – Index of body. kparp (`KPAR`) – Type of primary particles

class pypenelopetools.penelope.keywords.MFNAME[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Name of a PENELOPE input material data file.

This file must be generated in advance by running the program MATERIAL.

set(filename)[source]¶

Sets filename.

Parameters:	filename (str) – File name of material file (up to 20 characters).

class pypenelopetools.penelope.keywords.MSIMPA[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Set of simulation parameters for this material

absorption energies, EABS(1:3,M),
elastic scattering parameters, C1(M) and C2(M), and
cutoff energy losses for inelastic collisions and Bremsstrahlung emission, WCC(M) and WCR(M).

set(eabs1, eabs2, eabs3, c1, c2, wcc, wcr)[source]¶

Sets parameters.

Parameters:

eabs1 (float) – Absorption energy of electrons in eV.
eabs2 (float) – Absorption energy of photons in eV.
eabs3 (float) – Absorption energy of positrons in eV.
c1 (float) – Elastic scattering coefficient.
c2 (float) – Elastic scattering coefficient.
wcc (float) – Cutoff energy losses for inelastic collisions in eV.
wcr (float) – Cutoff energy losses for Bremsstrahlung emission in eV.

class pypenelopetools.penelope.keywords.MaterialGroup[source]¶

Bases: pypenelopetools.penelope.keyword.KeywordGroupBase

Group to define both material file name and its simulation parameters.

get_keywords()[source]¶: Returns: tuple: Keywords apart of this group.

set(filename, eabs1, eabs2, eabs3, c1, c2, wcc, wcr, index=None)[source]¶

Sets material file name and simulation parameters.

Parameters:

filename (str) – File name of material file (up to 20 characters).
eabs1 (float) – Absorption energy of electrons in eV.
eabs2 (float) – Absorption energy of photons in eV.
eabs3 (float) – Absorption energy of positrons in eV.
c1 (float) – Elastic scattering coefficient.
c2 (float) – Elastic scattering coefficient.
wcc (float) – Cutoff energy losses for inelastic collisions in eV.
wcr (float) – Cutoff energy losses for Bremsstrahlung emission in eV.
index (int, optional) – Index of this material in the geometry

class pypenelopetools.penelope.keywords.Materials(maxlength=10)[source]¶

Bases: pypenelopetools.penelope.keyword.KeywordSequence

Definition of materials.

add(index, filename, eabs1, eabs2, eabs3, c1, c2, wcc, wcr)[source]¶

Adds a new material.

Parameters:

index (int) – Index of this material in the geometry
filename (str) – File name of material file (up to 20 characters).
eabs1 (float) – Absorption energy of electrons in eV.
eabs2 (float) – Absorption energy of photons in eV.
eabs3 (float) – Absorption energy of positrons in eV.
c1 (float) – Elastic scattering coefficient.
c2 (float) – Elastic scattering coefficient.
wcc (float) – Cutoff energy losses for inelastic collisions in eV.
wcr (float) – Cutoff energy losses for Bremsstrahlung emission in eV.

get()[source]¶: Returns: tuple: Value(s) of all keywords.

write(fileobj)[source]¶

Writes to a PENELOPE-type file.

Parameters:	fileobj (file object) – File object opened with write access.

class pypenelopetools.penelope.keywords.NBANGL[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Definition of angular distributions of emerging particles.

Note

In the output files, the terms ‘upbound’ and ‘downbound’ are used to denote particles that leave the material system moving upwards (W>0) and downwards (W<0), respectively.

set(nbth, nbph)[source]¶

Sets angular distributions.

Parameters:	nbth (int) – Numbers of bins for the polar angle THETA. Should be less than 3600. If NBTH is positive, angular bins have uniform width, DTH=180./NBTHE. When NBTH is negative, the bin width increases geometrically with THETA, i.e., the bins have uniform width on a logarithmic scale. nbph (int) – Number of bins for the azimuthal angle PHI Should be less than 180.

class pypenelopetools.penelope.keywords.NBE[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Definition of energy distributions of emerging particles.

set(el, eu, nbe)[source]¶

Sets energy distributions.

Parameters:	el (float) – Lower limit in eV. eu (float) – Upper limit in eV. nbe (int) – Number of bins in the output energy distribution. Should be less than 1000. If NBE is positive, energy bins have uniform width, DE=(EU-EL)/NBE. When NBE is negative, the bin width increases geometrically with the energy, i.e., the energy bins have uniform width on a logarithmic scale.

class pypenelopetools.penelope.keywords.NSIMSH[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Desired number of simulated showers.

set(dshn)[source]¶

Sets showers.

Parameters:	dshn (int) – Number of simulated showers.

class pypenelopetools.penelope.keywords.RESUME[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Name of the resume file.

The program will read the dump file named dump1.dmp and resume the simulation from the point where it was left.

Warning

Use this option very, VERY carefully. Make sure that the input data file is fully consistent with the one used to generate the dump file.

set(filename)[source]¶

Sets filename.

Parameters:	filename (str) – File name of resume file (up to 20 characters).

class pypenelopetools.penelope.keywords.RSEED[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Seeds of the random-number generator.

set(iseed1, iseed2)[source]¶

Sets seeds.

Parameters:	iseed1 (int) – First seed. When ISEED1 is equal to a negative integer, -N, the seeds are set by calling subroutine RAND0(N) with the input argument equal to N. This ensures that sequences of random numbers used in different runs of the program (with different values of N) are truly independent. iseed2 (int) – Second seed.

class pypenelopetools.penelope.keywords.SCONE[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Initial direction of primary particles is sampled uniformly within a conical beam.

Conical source beam. Polar and azimuthal angles of the beam axis direction, THETA and PHI, and angular aperture, ALPHA, in deg.

The case ALPHA=0 defines a monodirectional source, and ALPHA =180 deg corresponds to an isotropic source.

set(theta, phi, alpha)[source]¶

Sets angles.

Parameters:	theta (float) – Polar angle of the beam axis direction in deg. phi (float) – Azimuthal angle of the beam axis direction in deg. alpha (float) – Angular aperture in deg.

class pypenelopetools.penelope.keywords.SENERG[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

For a monoenergetic source, initial energy SE0 of primary particles.

set(se0)[source]¶

Sets value.

Parameters:	se0 (float) – Initial energy of primary particles in eV

class pypenelopetools.penelope.keywords.SGPOL[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Activates the simulation of polarisation effects in the scattering of photons.

This line activates the simulation of polarisation effects in the scattering of photons (electrons and positrons are assumed to be unpolarised). SP1, SP2, SP3 are the Stokes parameters of primary photons, which define the degrees of linear polarisation at 45 deg azimuth, of circular polarisation, and of linear polarisation at zero azimuth, respectively. It is assumed that secondary photons are emitted with null polarisation (SP1=SP2=SP3=0).

set(sp1, sp2, sp3)[source]¶

Sets Stokes polarisation parameters.

Parameters:	sp1 (float) – Degrees of linear polarisation at 45 deg azimuth sp2 (float) – Degrees of circular polarisation sp3 (float) – Degrees of linear polarisation at 0 deg azimuth

class pypenelopetools.penelope.keywords.SKPAR[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Type of primary particle KPARP (1=electrons, 2=photons or 3=positrons).

If KPARP=0, the initial states of primary particles are set by subroutine SOURCE, to be provided by the user. An example of that subroutine, corresponding to a 60-Co source (two gamma rays in each nuclear deexcitation), is included in the PENMAIN package (file ‘source.f’).

set(kparp)[source]¶

Sets value.

Parameters:	kparp (`KPAR`) – Type of primary particles

class pypenelopetools.penelope.keywords.SPECTR(maxlength=1000)[source]¶

Bases: pypenelopetools.penelope.keyword.KeywordSequence

Define a source with continuous (stepwise constant) spectrum.

For a source with continuous (stepwise constant) spectrum, each ‘SPECTR’ line gives the lower end-point of an energy bin of the source spectrum (Ei) and the associated relative probability (Pi), integrated over the bin. Up to NSEM=1000 lines, in arbitrary order. The upper end of the spectrum is defined by entering a line with Ei equal to the upper energy end point and with a negative Pi value.

add(ei, pi)[source]¶

Adds a step in the spectrum.

Parameters:	ei (float) – Lower end-point of an energy bin of the source spectrum in eV pi (float) – Associated relative probability

class pypenelopetools.penelope.keywords.SPOSIT[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Coordinates of the source centre.

set(sx0, sy0, sz0)[source]¶

Sets coordinates.

Parameters:	sx0 (float) – x-coordinate in cm. sy0 (float) – y-coordinate in cm. sz0 (float) – z-coordinate in cm.

class pypenelopetools.penelope.keywords.SRECTA[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Initial direction of primary particles is sampled uniformly within a rectangular beam.

Rectangular source beam. Limiting polar and azimuthal angles of the source beam window, (THETAL,THETAU)x(PHIL,PHIU), in deg.

The case THETAL=THETAU, PHIL=PHIU defines a monodirectional source. To define an isotropic source, set THETAL=0, THETAU= 180, PHIL=0 and PHIU=360.

set(thetal, thetau, phil, phiu)[source]¶

Sets angles.

Parameters:	thetal (float) – Lower limit polar angle in deg. thetau (float) – Upper limit polar angle in deg. phil (float) – Lower limit azimuthal angle in deg. phiu (float) – Upper limit azimuthal angle in deg.

class pypenelopetools.penelope.keywords.TIME[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Allotted simulation time.

set(timea)[source]¶

Sets simulation time.

Parameters:	timea (int) – Allotted simulation time in seconds.

class pypenelopetools.penelope.keywords.TITLE[source]¶

Bases: pypenelopetools.penelope.keyword.TypeKeyword

Title of the job.

The TITLE string is used to mark dump files. To prevent the improper use of wrong resuming files, change the title each time you modify basic parameters of your problem. The code will then be able to identify the inconsistency and to print an error message before stopping.

set(title)[source]¶

Sets value.

Parameters:	title (str) – Title of the job (up to 65 characters).

Separators¶

Separators used across different PENELOPE main programs.

pypenelopetools.penelope.separators.BREMSSTRAHLUNG_SPLITTING = <pypenelopetools.penelope.separator.Separator object>¶: Section for Bremsstralung splitting.

pypenelopetools.penelope.separators.DOT = <pypenelopetools.penelope.separator.Separator object>¶: Section separator.

pypenelopetools.penelope.separators.EMERGING_PARTICLES = <pypenelopetools.penelope.separator.Separator object>¶: Section for emerging particles.

pypenelopetools.penelope.separators.END = <pypenelopetools.penelope.separator.Separator object>¶: End separator

pypenelopetools.penelope.separators.ENERGY_DEPOSITON_DETECTORS = <pypenelopetools.penelope.separator.Separator object>¶: Section for energy deposition detectors.

pypenelopetools.penelope.separators.INTERACTION_FORCING = <pypenelopetools.penelope.separator.Separator object>¶: Section for interaction forcing(s).

pypenelopetools.penelope.separators.JOB_PROPERTIES = <pypenelopetools.penelope.separator.Separator object>¶: Section for job properties.

pypenelopetools.penelope.separators.MATERIAL = <pypenelopetools.penelope.separator.Separator object>¶: Section for material(s).

pypenelopetools.penelope.separators.SOURCE_DEFINITION = <pypenelopetools.penelope.separator.Separator object>¶: Section for source definition.

pypenelopetools.penelope.separators.XRAY_SPLITTING = <pypenelopetools.penelope.separator.Separator object>¶: Section for characteristic x ray splitting.