tracketch
=========

A Python toolkit for simulating track formation in CR-39 nuclear track
detectors irradiation with ions.

The work is published in the article
`A unified model for etched-track formation in CR-39 detectors using amorphous
track structure theory
<https://papers.ssrn.com/sol3/papers.cfm?abstract_id=6469212>`_
by Jeppe Brage Christensen.

.. note::

   Due to its dependency on `libamtrack <https://libamtrack.github.io/>`_,
   **tracketch** currently runs on **Linux only**. Most Windows installations
   support WSL installations.


.. toctree::
   :maxdepth: 2
   :caption: User Guide

   getting_started
   examples
   algorithms

.. toctree::
   :maxdepth: 2
   :caption: Reference

   api/index

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`