material – Program to create material file(s)

class penelopetools.api.program.material.Material2006(configfilepath=None)

Bases: penelopetools.api.program.material._Material

Program for creating material for the 2006 release of PENELOPE. In this version, a single material file is created and contains all the defined materials of a simulation.

In the configuration file, the section Material2006 is read. It requires three options:

• filename of the program
• path to the program
• path to the input files to create the material

Base class to the material program of the different PENELOPE versions. The class attribute SECTION_NAME and the method create_material_files must be implemented.

A material program requires three options to be defined in its section of the configuration file:

• filename of the program
• path to the program
• path to the input files to create the material

Parameters:configfilepath (str) – location of the configuration file

SECTION_NAME = 'Material2006'

create_material_files(materials, folder)

Creates the material file containing the definition of all the specified materials. The file is saved in the specified folder

Parameters:

• materials (Materials) – materials
• folder (str) – folder where to save the material file

class penelopetools.api.program.material.Material2008(configfilepath=None)

Bases: penelopetools.api.program.material._Material

Program for creating material for the 2008 release of PENELOPE. In this version, a material file is created for each material defined in the simulation.

In the configuration file, the section Material2008 is read. It requires three options:

• filename of the program
• path to the program
• path to the input files to create the material

Base class to the material program of the different PENELOPE versions. The class attribute SECTION_NAME and the method create_material_files must be implemented.

A material program requires three options to be defined in its section of the configuration file:

• filename of the program
• path to the program
• path to the input files to create the material

Parameters:configfilepath (str) – location of the configuration file

SECTION_NAME = 'Material2008'

create_material_files(materials, folder)

Creates the material files each containing the definition of a material. The files are saved in the specified folder

Parameters:

• materials (Materials) – materials
• folder (str) – folder where to save the material file

class penelopetools.api.program.material.Material2008mod(configfilepath=None)

Bases: penelopetools.api.program.material.Material2008

Modification of the program for creating material for the 2008 release of PENELOPE. The modification allows material file(s) to be created without storing a temporary material file in the pendbase directory.

In the configuration file, the section Material2008mod is read. It requires three options:

• filename of the program
• path to the program
• path to the input files to create the material

Base class to the material program of the different PENELOPE versions. The class attribute SECTION_NAME and the method create_material_files must be implemented.

A material program requires three options to be defined in its section of the configuration file:

• filename of the program
• path to the program
• path to the input files to create the material

Parameters:configfilepath (str) – location of the configuration file

SECTION_NAME = 'Material2008mod'

class penelopetools.api.program.material.Material2011(configfilepath=None)

Bases: penelopetools.api.program.material.Material2008

Same as Material2008.

Base class to the material program of the different PENELOPE versions. The class attribute SECTION_NAME and the method create_material_files must be implemented.

A material program requires three options to be defined in its section of the configuration file:

• filename of the program
• path to the program
• path to the input files to create the material

Parameters:configfilepath (str) – location of the configuration file

SECTION_NAME = 'Material2011'

class penelopetools.api.program.material.Material2011mod(configfilepath=None)

Bases: penelopetools.api.program.material.Material2008mod

Same as Material2008mod.

Base class to the material program of the different PENELOPE versions. The class attribute SECTION_NAME and the method create_material_files must be implemented.

A material program requires three options to be defined in its section of the configuration file:

• filename of the program
• path to the program
• path to the input files to create the material

Parameters:configfilepath (str) – location of the configuration file

SECTION_NAME = 'Material2011mod'