Metadata-Version: 2.4
Name: irradiapy
Version: 0.2.3
Summary: This Python package is aimed towards the simulation and analysis of irradiation damage with multiple tools.
Author-email: "Gutiérrez-Camacho, A.-C." <abel.gutierrez@ua.es>
License: MIT
Requires-Python: >=3.10.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib>=3.10.1
Requires-Dist: numpy>=2.2.4
Requires-Dist: PyGetWindow>=0.0.9
Requires-Dist: pywinauto>=0.6.8
Requires-Dist: scikit_learn>=1.6.0
Requires-Dist: scipy>=1.14.1
Requires-Dist: mpi4py>=3.0.0
Dynamic: license-file

# Irradiapy

This Python package is aimed towards the simulation and analysis of irradiation damage with multiple tools.

This initial version works and is ready for production, but the code is under revision to improve usability, readability and efficiency. You can find an example under the `examples` folder. More examples will be provided with the next version, as well as a documentation page.

## srimpy

This subpackage runs [SRIM](http://www.srim.org/) from Python with some tweaks for automation . All SRIM outputs are saved into a SQLite database for easy use.

Please note that:
- You must obtain SRIM and make it work on own before using this functionality. SRIM is not included here.
- SRIM was designed to be run with a GUI. I managed to handled it the best way I could. A SRIM window will open in every run, but it will be minimised.
- I think this can adapted to run in Linux with Wine, but I do not have a Linux system. Someone could help with this.

With this subpackage, you get the list of PKAs produced by ions, and then you can place molecular dynamics collisional cascades debris accordinly, as described in [to be published]. You can find the database we used in [to be published] in [CascadesDefectsDB](https://github.com/acgc99/CascadesDefectsDB.git) repository.

## lammpspy

I am also working on a Python workflow that uses the corresponding LAMMPS API to generate databases of molecular dynamcis cascades "easily". This is in development and will be publish later.
