Repository navigation
v0.6.0
Changes since pysrim 0.5.10. See
changes from pysrim for credits and details.
Added
- Run SRIM under
xvfb-run -awhen it is available, so no display is needed (Jan Mayer). - Parse SRIM output written with comma decimal separators (philis-johan, MrRobot2211).
- Support the
m(metre) length unit in SR output (Angus Hollands). SRIMOutputParseErrorfor unknown units in SR output.- GitHub Actions: lint, test matrix (Python 3.11 to 3.15 on Linux, Windows and macOS), build, and a trusted-publishing release workflow.
- Ruff configuration and pre-commit hooks.
- Documentation: change list relative to pysrim, changelog page,
AGENTS.md.
Changed
- The distribution is renamed to
pysrim2; the import namesrimis unchanged. It cannot be installed alongsidepysrim. - Requires Python 3.11 or newer.
- Packaging uses
pyproject.toml, hatchling and uv (Angus Hollands). - Wine is detected with
shutil.whichthrough a shared launch helper (Mirochill). - Code formatted with ruff.
- Documentation uses the furo theme, is built with uv, and is hosted at https://pysrim2.readthedocs.io.
- README and installation instructions rewritten for pysrim2.
Fixed
- Removed the
distutilsimport so the package imports on Python 3.12 and later (lievcm). - Regular expressions use raw strings, removing invalid escape sequence warnings (lievcm).
- Ion energies with a leading or trailing decimal point (such as
.3 keV) are parsed (Mirochill, George Apostolopoulos, SimonF24). - Positive
autosaveintervals are accepted (Mirochill). - The sputtered output setting is honoured independently of ranges (Mirochill).
- The element database file is closed after loading.
- Undefined names: the
NotImpementedErrortypo inSRIM_Output._read_target, and missingnumpyimport andfolderargument insrim.plot. - Plot functions read
Resultsattributes instead of subscriptingResults. - Docstring markup errors that produced Sphinx warnings.
Removed
- Support for Python versions before 3.11.
setup.py,setup.cfg, the conda recipe,install.sh,default.nix, GitLab CI and the old Dockerfiles. A container image and a SRIM installer for wine are planned.
Versions up to and including 0.5.10 were released as pysrim by Chris Ostrouchov.