




<!-- README.md was auto-generated by README.Rmd. Please DO NOT edit by hand!-->

# RLumCarlo <img width=120px src="man/figures/Logo_RLumCarlo.png" align="right" />

The **R** package RLumCarlo provides a collection of R functions
modelling luminescence production in isolators and semiconductors for
various stimulation modes using Monte Carlo methods.

[![Project Status:
Concept](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![CRAN](https://www.r-pkg.org/badges/version/RLumCarlo)](https://CRAN.R-project.org/package=RLumCarlo)
[![DOI](https://zenodo.org/badge/82188344.svg)](https://zenodo.org/badge/latestdoi/82188344)
[![CRAN
DOI](https://img.shields.io/badge/doi-10.32614/CRAN.package.RLumCarlo-blue.svg)](https://doi.org/10.32614/CRAN.package.RLumCarlo)
[![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/RLumCarlo)](https://www.r-pkg.org/pkg/RLumCarlo)
[![R-CMD-check](https://github.com/R-Lum/RLumCarlo/workflows/GitHub%20Actions%20CI/badge.svg)](https://github.com/R-Lum/RLumCarlo/actions)
[![Coverage
Status](https://img.shields.io/codecov/c/github/R-Lum/RLumCarlo.svg)](https://app.codecov.io/github/R-Lum/RLumCarlo?branch=master)

## Installation

#### i. Requirements

Depending on your OS please download and install one of the following:

- *Windows*: [Rtools](https://cran.r-project.org/bin/windows/Rtools/)
  (provided by CRAN)
- *macOS*: [Xcode](https://developer.apple.com) (provided by Apple)
- *Linux*: [gcc](https://gcc.gnu.org) often comes pre-installed in most
  distributions. Should [gcc](https://gcc.gnu.org) be not available,
  however, we kindly refer to the exhaustive collection of installation
  guides depending on the Linux distribution.

#### ii. Install the package from GitHub

``` r
if(!require("devtools"))
  install.packages("devtools")
devtools::install_github("R-Lum/RLumCarlo@master")
```

## Examples

``` r
run_MC_CW_IRSL_TUN(A = 0.12, rho = 0.003, times = 0:1000) %>%
     plot_RLumCarlo(norm = TRUE, legend = TRUE)
```

<img src="man/figures/README-unnamed-chunk-2-1.png" style="display: block; margin: auto;" />

## Supported models

| TRANSITION               | BASE MODEL | IRSL  | OSL   | LM-OSL | TL   |
|--------------------------|------------|-------|-------|--------|------|
| Delocalised              | OTOR       | FALSE | TRUE  | TRUE   | TRUE |
| Localised                | GOT        | TRUE  | FALSE | TRUE   | TRUE |
| Excited state tunnelling | LTM        | TRUE  | FALSE | TRUE   | TRUE |

## License

This program is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or any later
version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the [GNU
General Public
License](https://github.com/R-Lum/RLumCarlo/blob/master/LICENSE) for
more details.

## <span class="glyphicon glyphicon-euro"></span> Funding

The [development of RLumCarlo](https://github.com/R-Lum/RLumCarlo)
benefited from the support by various funding bodies:

- The initial work by Johannes Friedrich, Sebastian Kreutzer and
  Christoph Schmidt was supported by the DFG (2015–2018, SCHM 3051/4-1,
  “Modelling quartz luminescence signal dynamics relevant for dating and
  dosimetry”, SCHM 3051/4-1).

- Later financial support was secured through the project *‘ULTIMO:
  Unifying Luminescence Models of quartz and feldspar (German Academic
  Exchange Service) DAAD: Deutscher Akademischer Austauschdienst DAAD
  PPP USA 2018, ID: 57387041)’*.

- The work of Sebastian Kreutzer as maintainer of the package was
  supported by LabEx LaScArBx (ANR - n. ANR-10-LABX-52) between 2017 and
  2019.

- From 2020, Sebastian Kreutzer received funding from the European
  Union’s Horizon 2020 research and innovation programme under the Marie
  Skłodowska-Curie grant agreement No 844457 (project: CREDit).

## Related projects

- [Luminescence](https://github.com/R-Lum/Luminescence)
- [RLumModel](https://github.com/R-Lum/RLumModel)
