Skip to main content

srim heatmap

pysrim2: Automation, Analysis, and Plotting of SRIM Calculations

pysrim2 is a maintained continuation of pysrim by Chris Ostrouchov. See what changed.

PyPI CI Documentation License

pysrim2 is a Python package that wraps and extends SRIM, a popular tool for simulating ions traveling through a material. It addresses several pain points of SRIM: automation and crash recovery of SRIM calculations, parsing of all output files, publication quality plots, and running on Linux and macOS.

The import name is unchanged: import srim. Because both packages provide the srim module, pysrim2 cannot be installed alongside the original pysrim.

Documentation: https://pysrim2.readthedocs.io/en/latest/

Installation

uv add pysrim2        # or: pip install pysrim2

If you have pysrim installed, remove it first: pip uninstall pysrim && pip install pysrim2. Python 3.11 or newer is required.

SRIM

SRIM itself is not included. Download it from srim.org. SRIM is copyright (c) James F. Ziegler and is free for non-commercial use only; check its licence before using it. You do not need SRIM if you only analyse existing output files.

  • Windows: extract the SRIM files into a directory and pass that directory to trim.run(). TRIM.exe should be in it.
  • Linux and macOS: install wine and extract SRIM into a directory. SRIM is compatible with wine. If xvfb-run is available, pysrim2 uses it so no display is needed. An installer for SRIM under wine is planned.
  • Container: a container image with SRIM under wine is planned.

Features

Automate running SRIM and TRIM on all operating systems

While TRIM is a great code it has many downsides regarding automation. The TRIM.IN input file is tedious to write yourself and the gui that constructs the TRIM.IN will crash at unexpeced moments. One of these crashes everyone has encountered is the fact that a float text field can never be empty. TRIM also has a tendancy to crash becuase it stores all cascades in memory. Meaning that for large runs with full cascades greater than 1,000 ions it will run out of memory. pysrim2 addresses all of these issues by providing a simple API wrapper for the input file (supporting all of the features), ability to run on all operating systems (using wine for linux and OSX), and allowing batch runs of calculations see this notebook example.

Below is a hello world example of using pysrim2 for running a TRIM calcualtion. Note that /tmp/srim is the path to the SRIM executable directory (SRIM.exe should reside in this directory). pysrim2 will add all the necessary input files. If this ran successfully the calculation starts. With wine and xvfb-run installed it runs headless; otherwise a TRIM window may appear.

from srim import Ion, Layer, Target, TRIM

# Construct a 3MeV Nickel ion
ion = Ion("Ni", energy=3.0e6)

# Construct a layer of nick 20um thick with a displacement energy of 30 eV
layer = Layer(
    {"Ni": {"stoich": 1.0, "E_d": 30.0, "lattice": 0.0, "surface": 3.0}}, density=8.9, width=20000.0
)

# Construct a target of a single layer of Nickel
target = Target([layer])

# Initialize a TRIM calculation with given target and ion for 25 ions, quick calculation
trim = TRIM(target, ion, number_ions=25, calculation=1)

# Specify the directory of SRIM.exe
# For windows users the path will include C://...
srim_executable_directory = "/tmp/srim"

# takes about 10 seconds on my laptop
results = trim.run(srim_executable_directory)
# If all went successfully, 25 ions were run (a TRIM window may have appeared
# if wine or xvfb-run is not available)!
# results is `srim.output.Results` and contains all output files parsed

See documentation for all available options.

Copy SRIM output files to directory

After a SRIM calculation has completed run copy_output_files to take all of the output files and move them to a directory of your liking.

from srim import TRIM

TRIM.copy_output_files("/tmp/srim", "/home/user/scratch/srim")

Post processes SRIM output as numpy arrays

By far the hardest part about running TRIM calculations is analyzing the output files. pysrim2 comes with parsers for IONIZ.txt, VACANCY.txt, NOVAC.txt, E2RECOIL.txt, PHONON.txt, RANGE.txt, and COLLISON.txt. The COLLISON.txt file can get quite large so the Collision parser uses a buffered reader that can handle any file size. Additinally a class srim.output.Results will processes all output files in a directory and provide a dictionary of each parsed output file. pysrim2 comes with some helpful plotting utilities such a plotting the DPA vs depth. However, pysrim2's most powerful feature is that all of the text files are exposed as numpy arrays. The example below shows how to plot DPA using a simple math and numpy. This enables the user to seamlessly use TRIM and do analysis.

from srim.output import Phonons, Ioniz


def plot_damage_energy(folder, ax):
    phon = Phonons(folder)
    dx = max(phon.depth) / 100.0
    energy_damage = (phon.ions + phon.recoils) * dx
    ax.plot(phon.depth, energy_damage / phon.num_ions, label="{}".format(folder))
    return sum(energy_damage)


def plot_ionization(folder, ax):
    ioniz = Ioniz(folder)
    dx = max(ioniz.depth) / 100.0
    ax.plot(ioniz.depth, ioniz.ions, label="Ionization from Ions")
    ax.plot(ioniz.depth, ioniz.recoils, label="Ionization from Recoils")

Set folders to list of directories to SRIM outputs. See Analysis for detailed example. Notice how there is a python class for each SRIM output file and gives simple access to each column. This did require some complex regex to get working just right.

folders = ["test_files/2", "test_files/4"]
image_directory = "examples/images"

fig, axes = plt.subplots(1, len(folders), sharey=True, sharex=True)

for ax, folder in zip(np.ravel(axes), folders):
    plot_damage_energy(folder, ax)
    plot_ionization(folder, ax)
    ax.legend()
    ax.set_ylabel("eV")
    ax.set_xlabel("Depth [Angstroms]")
fig.suptitle("Ionization Energy vs Depth", fontsize=15)
fig.set_size_inches((20, 6))
fig.savefig(os.path.join(image_directory, "ionizationvsdepth.png"), transparent=True)

srim heatmap

See jupyter notebook for full demonstration of features.

An example of creating some publication graphics with pysrim2 can also be found in the SiC notebook. Chris Ostrouchov used it in a publication.

Development

uv sync                          # set up the environment
uv run pytest                    # run the tests (from the repository root)
uv run pre-commit run --all-files   # lint and format
git config blame.ignoreRevsFile .git-blame-ignore-revs

The last command makes git blame skip the one-off formatting commit. See AGENTS.md for commit conventions. Bug reports and pull requests are welcome at https://github.com/FSIBT/pysrim2.

Credits

pysrim was written by Chris Ostrouchov with contributions from Alex Hanson and dschwen. pysrim2 includes fixes from many fork authors, listed in changes from pysrim.

License

MIT. See LICENSE. SRIM is licensed separately by its author.

Metadata

Release files for pysrim2 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pysrim2 0.6.0
File Size Uploaded Provenance Actions
pysrim2-0.6.0.tar.gz 5.7 MB With provenance Details for pysrim2-0.6.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pysrim2 0.6.0
File Interpreter ABI Platform Actions
pysrim2-0.6.0-py3-none-any.whl Python 3 none any Details for pysrim2-0.6.0-py3-none-any.whl

Total release size: 5.7 MB

Release files / pysrim2-0.6.0.tar.gz

Download URL pysrim2-0.6.0.tar.gz
Size 5.7 MB
Tags Source
SHA-256 checksum
How to use checksums
38b34c61c849ebf8efd91aa4ffc435b765d5345821d94338515fdcb2cefb1efc
BLAKE2b-256 checksum
How to use checksums
8cbaccf4db06cba07ffa4e4272c9474b003c004dda0676486ade780137bb3848
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 3, 2026.

Transparency log

Release files / pysrim2-0.6.0-py3-none-any.whl

Download URL pysrim2-0.6.0-py3-none-any.whl
Size 42.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4854861be876973e241a909625b19b1fd3d96b08c81f3f8fd536d0bff5111fbb
BLAKE2b-256 checksum
How to use checksums
878f3254d79c7d19e0fe142f5ef17f1b5fcaf1ebf7428cbae3d9eb89135b127e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 3, 2026.

Transparency log

Security for pysrim2 0.6.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for pysrim2-0.6.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 3, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page