Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/r-lum/rlumcarlo

RLumCarlo - Modelling luminescence using Monte Carlo methods
https://github.com/r-lum/rlumcarlo

feldspar geochronology luminescence luminescence-models monte-carlo-simulations r r-package simulation

Last synced: about 3 hours ago
JSON representation

RLumCarlo - Modelling luminescence using Monte Carlo methods

Host: GitHub
URL: https://github.com/r-lum/rlumcarlo
Owner: R-Lum
License: gpl-3.0
Created: 2017-02-16T14:18:43.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2024-07-20T16:39:06.000Z (4 months ago)
Last Synced: 2024-07-20T17:26:43.703Z (4 months ago)
Topics: feldspar, geochronology, luminescence, luminescence-models, monte-carlo-simulations, r, r-package, simulation
Language: R
Homepage: https://r-lum.github.io/RLumCarlo/
Size: 141 MB
Stars: 3
Watchers: 5
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.Rmd
- License: LICENSE
- Codemeta: codemeta.json

Awesome Lists containing this project

README

        ---

output: github_document

header-includes:

   - \usepackage{amsmath}

   - \usepackage{amssymb}

---

```{r, echo = FALSE, message=FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-"

)

library(RLumCarlo)

```

# RLumCarlo 

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 Actions CI/badge.svg)](https://github.com/R-Lum/RLumCarlo/actions)

[![Build status](https://ci.appveyor.com/api/projects/status/yxsmwa86jajhtesn?svg=true)](https://ci.appveyor.com/project/RLumSK/rlumcarlo)

[![codecov](https://app.codecov.io/gh/R-Lum/RLumCarlo/branch/master/graph/badge.svg?token=W0q5JUInf7)](https://app.codecov.io/gh/R-Lum/RLumCarlo)

## 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, fig.align='center'}

run_MC_CW_IRSL_TUN(A = 0.12, rho = 0.003, times = 0:1000) %>%

     plot_RLumCarlo(norm = TRUE, legend = TRUE)

```

## 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.

##  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)