Data

Tools

Indexes

Applications

Experiments

Open Source Science

rlummodel

Solving Ordinary Differential Equations to Understand Luminescence

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

Science Score: 36.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
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (19.3%) to scientific vocabulary

Keywords

differential-equations energy-band-model geochronology luminescence luminescence-models modelling quartz r simulation
Last synced: 4 months ago · JSON representation

Repository

Solving Ordinary Differential Equations to Understand Luminescence

Basic Info
  • Host: GitHub
  • Owner: R-Lum
  • License: gpl-3.0
  • Language: R
  • Default Branch: master
  • Homepage:
  • Size: 21.9 MB
Statistics
  • Stars: 5
  • Watchers: 7
  • Forks: 0
  • Open Issues: 2
  • Releases: 12
Topics
differential-equations energy-band-model geochronology luminescence luminescence-models modelling quartz r simulation
Created about 10 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(RLumModel)
```

# RLumModel 

[![DOI](https://zenodo.org/badge/47547833.svg)](https://zenodo.org/badge/latestdoi/47547833)
[![CRAN](https://www.r-pkg.org/badges/version/RLumModel)](https://CRAN.R-project.org/package=RLumModel )
[![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/RLumModel)](https://www.r-pkg.org/pkg/RLumModel)
[![Downloads](https://cranlogs.r-pkg.org/badges/RLumModel)](https://www.r-pkg.org/pkg/RLumModel)
[![Downloads](https://cranlogs.r-pkg.org/badges/last-week/RLumModel)](https://www.r-pkg.org/pkg/RLumModel)
[![Downloads](https://cranlogs.r-pkg.org/badges/last-day/RLumModel)](https://www.r-pkg.org/pkg/RLumModel)
[![R-CMD-check](https://github.com/R-Lum/RLumModel/workflows/GitHub Actions CI/badge.svg)](https://github.com/R-Lum/RLumModel/actions)
[![Build status](https://ci.appveyor.com/api/projects/status/42umfq97ifr021mk/branch/master?svg=true)](https://ci.appveyor.com/project/RLumSK/rlummodel/branch/master)
[![Coverage Status](https://img.shields.io/codecov/c/github/R-Lum/RLumModel.svg)](https://codecov.io/github/R-Lum/RLumModel?branch=master)

The **R** package `'RLumModel'` by Johannes Friedrich (University of Bayreuth, Germany), 
Sebastian Kreutzer (Geography & Earth Sciences, Aberystwyth University, United Kingdom) and Christoph Schmidt 
(University of Lausanne, Switzerland)
provides a collection of various R functions modelling luminescence signals in quartz and Al2O3, based on energy-band models.

For an introduction and further details, visit the [RLumModel homepage](https://r-lum.github.io/RLumModel/).

## Installation

### Install the package

To install the stable version from CRAN, simply run the following from an R console:

```{r, eval = FALSE}
install.packages("RLumModel")
```

To install the latest development builds directly from GitHub, run

```{r, eval = FALSE}
if(!require("devtools"))
  install.packages("devtools")
devtools::install_github("R-Lum/RLumModel@master")
```

To install a developer build other than 'master', replace the term 'master' in the codeline by the name
of the wanted developer build. 

### 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/xcode/) (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.

## Using RLumModel

### Simple Example

```{r}
model <- "Bailey2001"

sequence <- list(
    IRR = c(20, 10, 1),
    TL = c(20, 500, 5))
    
model.output <- model_LuminescenceSignals(
    model = model,
    sequence = sequence,
    verbose = FALSE
)
```


## Note

**The package comes without any guarantee!**

Please further note that this version is a development version and may change day by day. 
For stable branches please visit the package on CRAN.

## 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/RLumModel/blob/master/LICENSE) for more details.

##  Funding

The [development of RLumModel](https://github.com/R-Lum/RLumModel)
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)

-   The work of Sebastian Kreutzer as package author was
    supported by [LabEx LaScArBx (ANR -
    n. ANR-10-LABX-52)](https://lascarbx.labex.u-bordeaux.fr) 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)
* [RLumShiny](https://github.com/tzerk/RLumShiny)
* [RLumCarlo](https://github.com/R-Lum/RLumCarlo)

Owner

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

Enlightening the past and shaping the future

CodeMeta (codemeta.json) 

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "RLumModel",
  "description": "A collection of functions to simulate luminescence signals in quartz and Al2O3 based on published models.",
  "name": "RLumModel: Solving Ordinary Differential Equations to Understand Luminescence",
  "codeRepository": "https://github.com/R-Lum/RLumModel",
  "issueTracker": "https://github.com/R-Lum/RLumModel/issues",
  "license": "https://spdx.org/licenses/GPL-3.0",
  "version": "0.2.11",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R Under development (unstable) (2025-09-18 r88857)",
  "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",
      "email": "johannes.friedrich@posteo.de",
      "@id": "https://orcid.org/0000-0002-0805-9547"
    },
    {
      "@type": "Person",
      "givenName": "Sebastian",
      "familyName": "Kreutzer",
      "@id": "https://orcid.org/0000-0002-0734-2199"
    },
    {
      "@type": "Person",
      "givenName": "Christoph",
      "familyName": "Schmidt",
      "@id": "https://orcid.org/0000-0002-2309-3209"
    }
  ],
  "contributor": [
    {
      "@type": "Person",
      "givenName": "Sebastian",
      "familyName": "Kreutzer",
      "@id": "https://orcid.org/0000-0002-0734-2199"
    },
    {
      "@type": "Person",
      "givenName": "Christoph",
      "familyName": "Schmidt",
      "@id": "https://orcid.org/0000-0002-2309-3209"
    },
    {
      "@type": "Person",
      "givenName": "Johannes",
      "familyName": "Friedrich",
      "email": "johannes.friedrich@posteo.de",
      "@id": "https://orcid.org/0000-0002-0805-9547"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Johannes",
      "familyName": "Friedrich",
      "email": "johannes.friedrich@posteo.de",
      "@id": "https://orcid.org/0000-0002-0805-9547"
    }
  ],
  "softwareSuggestions": [
    {
      "@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"
    },
    {
      "@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"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "R",
      "name": "R",
      "version": ">= 4.4"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "utils",
      "name": "utils"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "Luminescence",
      "name": "Luminescence",
      "version": ">= 1.1.1",
      "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=Luminescence"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "deSolve",
      "name": "deSolve",
      "version": ">= 1.40",
      "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=deSolve"
    },
    "5": {
      "@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"
    },
    "6": {
      "@type": "SoftwareApplication",
      "identifier": "methods",
      "name": "methods"
    },
    "7": {
      "@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"
    },
    "SystemRequirements": null
  },
  "fileSize": "2061.045KB",
  "relatedLink": "https://CRAN.R-project.org/package=RLumModel",
  "releaseNotes": "https://github.com/R-Lum/RLumModel/blob/main/NEWS.md",
  "readme": "https://github.com/R-Lum/RLumModel/blob/master/README.md",
  "contIntegration": [
    "https://ci.appveyor.com/project/RLumSK/rlummodel/branch/master",
    "https://app.codecov.io/github/R-Lum/RLumModel"
  ],
  "keywords": [
    "modelling",
    "luminescence",
    "quartz",
    "simulation",
    "differential-equations",
    "energy-band-model",
    "geochronology",
    "luminescence-models",
    "r"
  ]
}

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 13
  • Total pull requests: 0
  • Average time to close issues: 7 months
  • Average time to close pull requests: N/A
  • Total issue authors: 2
  • Total pull request authors: 0
  • Average comments per issue: 2.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
  • tzerk (8)
  • RLumSK (5)
Pull Request Authors
Top Labels
Issue Labels
enhancement (6) bug (2) question (2) help wanted (2)
Pull Request Labels

Dependencies

.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
DESCRIPTION cran
  • Luminescence >= 0.9.18 depends
  • R >= 4.0 depends
  • utils * depends
  • Rcpp >= 1.0.8 imports
  • deSolve >= 1.30 imports
  • khroma >= 1.8.0 imports
  • methods * imports
  • R.rsp >= 0.44.0 suggests
  • testthat >= 3.1.0 suggests