irradiapy.srim.ofiles package

Submodules

irradiapy.srim.ofiles.backscat module

This module contains the Backscat class.

class irradiapy.srim.ofiles.backscat.Backscat(srim)[source]

Bases: SRIMFile

Class to handle BACKSCAT.txt file.

get_nions()[source]

Returns the number of ions in the database.

Returns:: Number of ions.
Return type:: int

merge(srimdb2)[source]

Merges the backscat table with another database.

Parameters:: srimdb2 (SRIMDB) – SRIM database to merge.
Return type:: None

process_file(backscat_path)[source]

Processes BACKSCAT.txt file.

Parameters:: backscat_path (Path) – BACKSCAT.txt path.
Return type:: None

read(what='*', condition='')[source]

Reads backsact data from the database as a generator.

Parameters:

what (str) – Columns to select.
condition (str) – Condition to filter data.

Yields:

Generator[tuple, None, None] – Data from the database.

Return type:

Generator[tuple, None, None]

irradiapy.srim.ofiles.collision module

This module contains the Collision class.

class irradiapy.srim.ofiles.collision.Collision(srimdb)[source]

Bases: SRIMFile

Class for processing the COLLISON.txt file.

read(what='*', condition='')[source]

Reads data from the collision table.

Parameters:

what (str, optional (default="*")) – Columns to read.
condition (str, optional (default="")) – Condition to filter data.

Yields:

tuple – Data from the collision table.

Return type:

Generator[tuple, None, None]

irradiapy.srim.ofiles.e2recoil module

This module contains the E2Recoil class.

class irradiapy.srim.ofiles.e2recoil.E2Recoil(srimdb)[source]

Bases: SRIMFile

Class to handle E2RECOIL.txt file.

read(what='*', condition='')[source]

Reads e2recoil data from the database as a generator.

Parameters:

what (str) – Columns to select.
condition (str) – Condition to filter data.

Yields:

Generator[tuple, None, None] – Data from the database.

Return type:

Generator[tuple, None, None]

irradiapy.srim.ofiles.ioniz module

This module contains the Ioniz class.

class irradiapy.srim.ofiles.ioniz.Ioniz(srim)[source]

Bases: SRIMFile

Class to handle IONIZ.txt file.

merge(srimdb2)[source]

Merges the ioniz table with another database.

Parameters:: srimdb2 (SRIMDB) – SRIM database to merge.
Return type:: None

process_file(ioniz_path)[source]

Processes IONIZ.txt file.

Parameters:: ioniz_path (Path) – IONIZ.txt path.
Return type:: None

read(what='*', condition='')[source]

Reads ioniz data from the database as a generator.

Parameters:

what (str) – Columns to select.
condition (str) – Condition to filter data.

Yields:

Generator[tuple, None, None] – Data from the database.

Return type:

Generator[tuple, None, None]

irradiapy.srim.ofiles.lateral module

This module contains the Ioniz class.

class irradiapy.srim.ofiles.lateral.Lateral(srim)[source]

Bases: SRIMFile

Class to handle LATERAL.txt file.

merge(srimdb2)[source]

Merges the lateral table with another database.

Parameters:: srimdb2 (SRIMDB) – SRIM database to merge.
Return type:: None

Note

Not sure if calculations are right, see Eqs. 9-1, 9-2 and 9-3,

process_file(lateral_path)[source]

Processes LATERAL.txt file.

Parameters:: lateral_path (Path) – LATERAL.txt path.
Return type:: None

read(what='*', condition='')[source]

Reads lateral data from the database as a generator.

Parameters:

what (str) – Columns to select.
condition (str) – Condition to filter data.

Yields:

Generator[tuple, None, None] – Data from the database.

Return type:

Generator[tuple, None, None]

irradiapy.srim.ofiles.novac module

This module contains the Novac class.

class irradiapy.srim.ofiles.novac.Novac(srim)[source]

Bases: SRIMFile

Class for processing the NOVAC.txt file.

merge(srimdb2)[source]

Merges the novac table with another database.

Parameters:: srimdb2 (SRIMDB) – SRIM database to merge.
Return type:: None

process_file(novac_path)[source]

Processes NOVAC.txt file.

Parameters:: novac_path (Path) – NOVAC.txt path.
Return type:: None

read(what='*', condition='')[source]

Reads the novac table.

Parameters:

what (str) – Columns to read.
condition (str) – Condition to filter the data.

Yields:

tuple – Data from the novac table.

Return type:

Generator[tuple, None, None]

irradiapy.srim.ofiles.phonon module

This module contains the Phonon class.

class irradiapy.srim.ofiles.phonon.Phonon(srim)[source]

Bases: SRIMFile

Class to handle PHONON.txt file.

merge(srimdb2)[source]

Merges the phonon table with another database.

Parameters:: srimdb2 (SRIMDB) – SRIM database to merge.
Return type:: None

process_file(phonon_path)[source]

Processes PHONON.txt file.

Parameters:: phonon_path (Path) – PHONON.txt path.
Return type:: None

read(what='*', condition='')[source]

Reads phonon data from the database as a generator.

Parameters:

what (str) – Columns to select.
condition (str) – Condition to filter data.

Yields:

Generator[tuple, None, None] – Data from the database.

Return type:

Generator[tuple, None, None]

irradiapy.srim.ofiles.range module

This module contains the Range class.

class irradiapy.srim.ofiles.range.Range(srimdb)[source]

Bases: SRIMFile

Class to handle RANGE.txt file.

read(what='*', condition='')[source]

Reads range data from the database as a generator.

Parameters:

what (str) – Columns to select.
condition (str) – Condition to filter data.

Yields:

Generator[tuple, None, None] – Data from the database.

Return type:

Generator[tuple, None, None]

irradiapy.srim.ofiles.range3d module

This module contains the Range3D class.

class irradiapy.srim.ofiles.range3d.Range3D(srim)[source]

Bases: SRIMFile

Class to handle RANGE_3D.txt file.

merge(srimdb2)[source]

Merges the range3d table with another database.

Parameters:: srimdb2 (SRIMDB) – SRIM database to merge.
Return type:: None

process_file(range3d_path)[source]

Processes RANGE_3D.txt file.

Parameters:: range3d_path (Path) – RANGE_3D.txt path.
Return type:: None

read(what='*', condition='')[source]

Reads range3d data from the database as a generator.

Parameters:

what (str) – Columns to select.
condition (str) – Condition to filter data.

Yields:

Generator[tuple, None, None] – Data from the database.

Return type:

Generator[tuple, None, None]

irradiapy.srim.ofiles.sputter module

This module contains the Sputter class.

class irradiapy.srim.ofiles.sputter.Sputter(srim)[source]

Bases: SRIMFile

Class to handle SPUTTER.txt file.

get_natoms()[source]

Returns the number of atoms in the database.

Returns:: Number of atoms.
Return type:: int

merge(srimdb2)[source]

Merges the sputter table with another database.

Parameters:: srimdb2 (SRIMDB) – SRIM database to merge.
Return type:: None

process_file(sputter_path)[source]

Processes SPUTTER.txt file.

Parameters:: sputter_path (Path) – SPUTTER.txt path.
Return type:: None

read(what='*', condition='')[source]

Reads sputter data from the database as a generator.

Parameters:

what (str) – Columns to select.
condition (str) – Condition to filter data.

Yields:

Generator[tuple, None, None] – Data from the database.

Return type:

Generator[tuple, None, None]

irradiapy.srim.ofiles.srimfile module

This module contains the SRIMFile class.

class irradiapy.srim.ofiles.srimfile.SRIMFile(srim)[source]

Bases: object

Base class for SRIM files.

commit()[source]

Commits the current transaction.

Return type:: None

cursor()[source]

Returns a cursor object using the current SRIM database connection.

Returns:: A cursor object for the SRIM database connection.
Return type:: sqlite3.Cursor

srim: SRIMDB

irradiapy.srim.ofiles.subcollision module

This module contains the Subcollision class.

class irradiapy.srim.ofiles.subcollision.Subcollision(srimdb)[source]

Bases: SRIMFile

Class for processing subcollision data.

empty()[source]

Empties the subcollision table.

Return type:: None

read(what='*', condition='')[source]

Reads data from the subcollision table.

Parameters:

what (str, optional (default="*")) – Columns to read.
condition (str, optional (default="")) – Condition to filter data.

Yields:

tuple – Data from the subcollision table.

Return type:

Generator[tuple, None, None]

irradiapy.srim.ofiles.transmit module

This module contains the Transmit class.

class irradiapy.srim.ofiles.transmit.Transmit(srim)[source]

Bases: SRIMFile

Class to handle TRANSMIT.txt file.

get_nions()[source]

Returns the number of ions in the database.

Returns:: Number of ions.
Return type:: int

merge(srimdb2)[source]

Merges the transmit table with another database.

Parameters:: srimdb2 (SRIMDB) – SRIM database to merge.
Return type:: None

process_file(transmit_path)[source]

Processes TRANSMIT.txt file.

Parameters:: transmit_path (Path) – TRANSMIT.txt path.
Return type:: None

read(what='*', condition='')[source]

Reads transmit data from the database as a generator.

Parameters:

what (str) – Columns to select.
condition (str) – Condition to filter data.

Yields:

Generator[tuple, None, None] – Data from the database.

Return type:

Generator[tuple, None, None]

irradiapy.srim.ofiles.trimdat module

This module contains the Trimdat class.

class irradiapy.srim.ofiles.trimdat.Trimdat(srim)[source]

Bases: SRIMFile

Class to handle TRIM.DAT file.

merge(srimdb2)[source]

Merges the trimdat table with another database.

Parameters:: srimdb2 (SRIMDB) – SRIM database to merge with.
Return type:: None

process_file(trimdat_path)[source]

Processes TRIM.DAT file.

Parameters:: trimdat_path (Path) – TRIM.DAT path.
Return type:: None

read(what='*', condition='')[source]

Reads trimdat data from the database as a generator.

Parameters:

what (str) – Columns to select.
condition (str) – Condition to filter data.

Yields:

Generator[tuple, None, None] – Data from the database.

Return type:

Generator[tuple, None, None]

irradiapy.srim.ofiles.vacancy module

This module contains the Vacancy class.

class irradiapy.srim.ofiles.vacancy.Vacancy(srimdb)[source]

Bases: SRIMFile

Class to handle VACANCY.txt file.

read(what='*', condition='')[source]

Reads vacancy data from the database as a generator.

Parameters:

what (str) – Columns to select.
condition (str) – Condition to filter data.

Yields:

Generator[tuple, None, None] – Data from the database.

Return type:

Generator[tuple, None, None]

Module contents

Subpackage for SRIM output files.