rlumcarlo

RLumCarlo - Modelling luminescence using Monte Carlo methods

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

Science Score: 49.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 3 DOI reference(s) in README
✓
Academic publication links
Links to: zenodo.org
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (20.8%) to scientific vocabulary

Keywords

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

Last synced: 4 months ago · JSON representation

Repository

RLumCarlo - Modelling luminescence using Monte Carlo methods

Basic Info

Host: GitHub
Owner: R-Lum
License: gpl-3.0
Language: R
Default Branch: master
Homepage: https://r-lum.github.io/RLumCarlo/
Size: 141 MB

Statistics

Stars: 3
Watchers: 3
Forks: 0
Open Issues: 0
Releases: 6

Topics

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

Created almost 9 years ago · Last pushed over 1 year ago

Metadata Files

Readme Changelog License Codemeta Zenodo

README.Rmd

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

Owner

Name: RLum.Network
Login: R-Lum
Kind: organization
Email: developers@r-luminescence.org
Location: Europe

Website: https://r-luminescence.org
Repositories: 11
Profile: https://github.com/R-Lum

Enlightening the past and shaping the future

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "RLumCarlo",
  "description": "A collection of functions to simulate luminescence production in dosimetric materials using Monte Carlo methods. Implemented are models for delocalised transitions (e.g., Chen and McKeever (1997) <doi:10.1142/2781>), localised transitions (e.g., Pagonis et al. (2019) <doi:10.1016/j.jlumin.2018.11.024>) and tunnelling transitions (Jain et al. (2012) <doi:10.1088/0953-8984/24/38/385402> and Pagonis et al. (2019) <doi:10.1016/j.jlumin.2018.11.024>). Supported stimulation methods are thermal luminescence (TL), continuous-wave optically stimulated luminescence (CW-OSL), linearly-modulated optically stimulated luminescence (LM-OSL), linearly-modulated infrared stimulated luminescence (LM-IRSL), and isothermal luminescence (ITL or ISO-TL).",
  "name": "RLumCarlo: Monte-Carlo Methods for Simulating Luminescence Phenomena",
  "codeRepository": "https://github.com/R-Lum/RLumCarlo",
  "issueTracker": "https://github.com/R-Lum/RLumCarlo/issues",
  "license": "https://spdx.org/licenses/GPL-3.0",
  "version": "0.1.10",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.5.1 (2025-06-13)",
  "provider": {
    "@id": "https://cran.r-project.org",
    "@type": "Organization",
    "name": "Comprehensive R Archive Network (CRAN)",
    "url": "https://cran.r-project.org"
  },
  "author": [
    {
      "@type": "Person",
      "givenName": "Johannes",
      "familyName": "Friedrich",
      "@id": "https://orcid.org/0000-0002-0805-9547"
    },
    {
      "@type": "Person",
      "givenName": "Sebastian",
      "familyName": "Kreutzer",
      "email": "sebastian.kreutzer@uni-heidelberg.de",
      "@id": "https://orcid.org/0000-0002-0734-2199"
    },
    {
      "@type": "Person",
      "givenName": "Vasilis",
      "familyName": "Pagonis",
      "@id": "https://orcid.org/0000-0002-4852-9312"
    },
    {
      "@type": "Person",
      "givenName": "Christoph",
      "familyName": "Schmidt",
      "@id": "https://orcid.org/0000-0002-2309-3209"
    }
  ],
  "contributor": [
    {
      "@type": "Person",
      "givenName": "Christian",
      "familyName": "Laag",
      "@id": "https://orcid.org/0000-0002-6012-1029"
    },
    {
      "@type": "Person",
      "givenName": "Ena",
      "familyName": "Rajovic"
    },
    {
      "@type": "Person",
      "givenName": "Alex Roy",
      "familyName": "Duncan"
    },
    {
      "@type": "Person",
      "givenName": "Johannes",
      "familyName": "Friedrich",
      "@id": "https://orcid.org/0000-0002-0805-9547"
    },
    {
      "@type": "Person",
      "givenName": "Sebastian",
      "familyName": "Kreutzer",
      "email": "sebastian.kreutzer@uni-heidelberg.de",
      "@id": "https://orcid.org/0000-0002-0734-2199"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Sebastian",
      "familyName": "Kreutzer",
      "email": "sebastian.kreutzer@uni-heidelberg.de",
      "@id": "https://orcid.org/0000-0002-0734-2199"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "spelling",
      "name": "spelling",
      "version": ">= 2.3.2",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=spelling"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "R.rsp",
      "name": "R.rsp",
      "version": ">= 0.46.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=R.rsp"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "version": ">= 3.2.3",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "R",
      "name": "R",
      "version": ">= 4.4"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "utils",
      "name": "utils"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "magrittr",
      "name": "magrittr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=magrittr"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "abind",
      "name": "abind",
      "version": ">= 1.4-8",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=abind"
    },
    "5": {
      "@type": "SoftwareApplication",
      "identifier": "doParallel",
      "name": "doParallel",
      "version": ">= 1.0.17",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=doParallel"
    },
    "6": {
      "@type": "SoftwareApplication",
      "identifier": "foreach",
      "name": "foreach",
      "version": ">= 1.5.2",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=foreach"
    },
    "7": {
      "@type": "SoftwareApplication",
      "identifier": "khroma",
      "name": "khroma",
      "version": ">= 1.16.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=khroma"
    },
    "8": {
      "@type": "SoftwareApplication",
      "identifier": "methods",
      "name": "methods"
    },
    "9": {
      "@type": "SoftwareApplication",
      "identifier": "parallel",
      "name": "parallel"
    },
    "10": {
      "@type": "SoftwareApplication",
      "identifier": "Rcpp",
      "name": "Rcpp",
      "version": ">= 1.1.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=Rcpp"
    },
    "11": {
      "@type": "SoftwareApplication",
      "identifier": "scatterplot3d",
      "name": "scatterplot3d",
      "version": ">= 0.3",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=scatterplot3d"
    },
    "12": {
      "@type": "SoftwareApplication",
      "identifier": "stats",
      "name": "stats"
    },
    "SystemRequirements": null
  },
  "fileSize": "1389.325KB",
  "citation": [
    {
      "@type": "SoftwareSourceCode",
      "datePublished": "2025",
      "author": [
        {
          "@type": "Person",
          "givenName": "Johannes",
          "familyName": "Friedrich",
          "@id": "https://orcid.org/0000-0002-0805-9547"
        },
        {
          "@type": "Person",
          "givenName": "Sebastian",
          "familyName": "Kreutzer",
          "email": "sebastian.kreutzer@uni-heidelberg.de",
          "@id": "https://orcid.org/0000-0002-0734-2199"
        },
        {
          "@type": "Person",
          "givenName": "Vasilis",
          "familyName": "Pagonis",
          "@id": "https://orcid.org/0000-0002-4852-9312"
        },
        {
          "@type": "Person",
          "givenName": "Christoph",
          "familyName": "Schmidt",
          "@id": "https://orcid.org/0000-0002-2309-3209"
        }
      ],
      "name": "RLumCarlo: Monte-Carlo Methods for Simulating Luminescence Phenomena",
      "url": "https://r-lum.github.io/RLumCarlo/",
      "description": "R package version 0.1.10"
    },
    {
      "@type": "ScholarlyArticle",
      "datePublished": "2021",
      "author": [
        {
          "@type": "Person",
          "givenName": "Sebastian",
          "familyName": "Kreutzer"
        },
        {
          "@type": "Person",
          "givenName": "Johannes",
          "familyName": "Friedrich"
        },
        {
          "@type": "Person",
          "givenName": "Vasilis",
          "familyName": "Pagonis"
        },
        {
          "@type": "Person",
          "givenName": "Christian",
          "familyName": "Laag"
        },
        {
          "@type": "Person",
          "givenName": "Ena",
          "familyName": "Rajovic"
        },
        {
          "@type": "Person",
          "givenName": "Christoph",
          "familyName": "Schmidt"
        }
      ],
      "name": "RLumCarlo: Simulating Cold Light using Monte Carlo Methods",
      "identifier": "10.32614/RJ-2021-043",
      "pagination": "351365",
      "@id": "https://doi.org/10.32614/RJ-2021-043",
      "sameAs": "https://doi.org/10.32614/RJ-2021-043",
      "isPartOf": {
        "@type": "PublicationIssue",
        "datePublished": "2021",
        "isPartOf": {
          "@type": [
            "PublicationVolume",
            "Periodical"
          ],
          "volumeNumber": "13",
          "name": "The R Journal"
        }
      }
    }
  ],
  "relatedLink": [
    "https://r-lum.github.io/RLumCarlo/",
    "https://CRAN.R-project.org/package=RLumCarlo"
  ],
  "releaseNotes": "https://github.com/R-Lum/RLumCarlo/blob/main/NEWS.md",
  "readme": "https://github.com/R-Lum/RLumCarlo/blob/master/README.md",
  "contIntegration": "https://app.codecov.io/github/R-Lum/RLumCarlo?branch=master",
  "developmentStatus": "https://www.repostatus.org/#active",
  "keywords": [
    "monte-carlo-simulations",
    "feldspar",
    "luminescence",
    "simulation",
    "geochronology",
    "r",
    "r-package",
    "luminescence-models"
  ]
}

GitHub Events

Total

Last Year

Issues and Pull Requests

Last synced: 7 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Dependencies

DESCRIPTION cran

R >= 4.1 depends
magrittr * depends
utils * depends
Rcpp >= 1.0.9 imports
abind >= 1.4 imports
doParallel >= 1.0.17 imports
foreach >= 1.5.2 imports
khroma >= 1.9.0 imports
methods * imports
parallel * imports
scatterplot3d >= 0.3 imports
stats * imports
R.rsp >= 0.45.0 suggests
spelling >= 2.2 suggests
testthat >= 3.1.4 suggests

.github/workflows/GitHub_Actions_CI.yaml actions

actions/cache v2 composite
actions/checkout v2 composite
actions/upload-artifact main composite
r-lib/actions/setup-pandoc v1 composite
r-lib/actions/setup-r v1 composite

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science