pyet-mc

Collection of routines for modelling the energy transfer processes in lanthanide doped materials.

https://github.com/jaminmartin/pyet-mc

Science Score: 54.0%

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

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: researchgate.net
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.9%) to scientific vocabulary

Keywords

lanthanides physics rare-earth-ions rare-earths spectroscopy
Last synced: 6 months ago · JSON representation ·

Repository

Collection of routines for modelling the energy transfer processes in lanthanide doped materials.

Basic Info
  • Host: GitHub
  • Owner: JaminMartin
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 4.65 MB
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 0
  • Open Issues: 2
  • Releases: 1
Topics
lanthanides physics rare-earth-ions rare-earths spectroscopy
Created over 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

PYET-MC

pyet_logo

A library to model energy transfer between lanthanide ions

Get in contact or follow research related to this project

Github   LinkedIn   ORCID   ResearchGate  

Table of Contents

Introduction

Collection of tools for modelling the energy transfer processes in lanthanide-doped materials.

Contains functions for visualising crystal structure around a central donor ion, subroutines for nearest neighbour probabilities and monte-carlo based multi-objective fitting for energy transfer rates. This package aims to streamline the fitting process while providing useful tools to obtain quick structural information. The core function of this library is the ability to simultaneously fit lifetime data for various concentrations to tie down energy transfer rates more accurately. This allows one to decouple certain dataset features, such as signal offset/amplitude, from physical parameters, such as radiative and energy transfer rates. This is all handled by a relatively straightforward API wrapping the Scipy Optimise library. This library is based on the scripts initially written for studying multi-polar interactions between samarium ions in KY3F10

Documentation

The documentation for this project, e.g. how to install and use the project can be found here: https://jaminmartin.github.io/pyet-mc/

Referencing this project

To reference this project, you can use the citation tool in the About info of this repository. Details can also be found in the .cff file in the source code.

License

The project is licensed under the GNU GENERAL PUBLIC LICENSE.

Owner

  • Name: Jamin Martin
  • Login: JaminMartin
  • Kind: user
  • Location: New Zealand
  • Company: University of Canterbury

PhD in Physics. Working on modelling crystal-field interactions in lanthanide-doped nanocrystals for biomedical and environmental sensing applications.

Citation (CITATION.cff)

cff-version: 1.2.0
title: pyet
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Jamin Luke Bruce
    family-names: Martin
    affiliation: University of Canterbury
    orcid: 'https://orcid.org/0000-0002-7204-231X'
repository-code: 'https://github.com/JaminMartin/pyet-mc'
abstract: >-
  Collection of methods for modelling the energy transfer
  processes in lanthanide-doped materials.
keywords:
  - lanthanides
  - energy transfer
  - spectroscopy
  - rare-earths
license: GPL-3.0+
date-released: '2023-08-13'

GitHub Events

Total
Last Year

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 185
  • Total Committers: 2
  • Avg Commits per committer: 92.5
  • Development Distribution Score (DDS): 0.103
Past Year
  • Commits: 185
  • Committers: 2
  • Avg Commits per committer: 92.5
  • Development Distribution Score (DDS): 0.103
Top Committers
Name Email Commits
JaminMartin j****1@g****m 166
Jamin Martin 3****n 19

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 8
  • Total pull requests: 0
  • Average time to close issues: about 1 month
  • Average time to close pull requests: N/A
  • Total issue authors: 2
  • Total pull request authors: 0
  • Average comments per issue: 1.25
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 0
  • Average time to close issues: 6 days
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.5
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • JaminMartin (6)
  • PakwanRin (1)
Pull Request Authors
Top Labels
Issue Labels
bug (5) enhancement (2)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 79 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 1
  • Total maintainers: 1
pypi.org: pyet-mc

Python package for calculating energy transfer rates between lanthanide ions

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 79 Last month
Rankings
Dependent packages count: 10.4%
Average: 34.6%
Dependent repos count: 58.7%
Maintainers (1)
Last synced: 6 months ago

Dependencies

.github/workflows/deploy.yml actions
  • actions/checkout v4 composite
  • actions/configure-pages v5 composite
  • actions/deploy-pages v4 composite
  • actions/upload-pages-artifact v3 composite
rust/Cargo.lock cargo
  • autocfg 1.3.0
  • bitflags 2.5.0
  • cfg-if 1.0.0
  • crossbeam-deque 0.8.5
  • crossbeam-epoch 0.9.18
  • crossbeam-utils 0.8.20
  • either 1.12.0
  • heck 0.4.1
  • indoc 2.0.5
  • libc 0.2.155
  • lock_api 0.4.12
  • memoffset 0.9.1
  • once_cell 1.19.0
  • parking_lot 0.12.3
  • parking_lot_core 0.9.10
  • portable-atomic 1.6.0
  • proc-macro2 1.0.84
  • pyo3 0.20.3
  • pyo3-build-config 0.20.3
  • pyo3-ffi 0.20.3
  • pyo3-macros 0.20.3
  • pyo3-macros-backend 0.20.3
  • quote 1.0.36
  • rayon 1.10.0
  • rayon-core 1.12.1
  • redox_syscall 0.5.1
  • scopeguard 1.2.0
  • smallvec 1.13.2
  • syn 2.0.66
  • target-lexicon 0.12.14
  • unicode-ident 1.0.12
  • unindent 0.2.3
  • windows-targets 0.52.5
  • windows_aarch64_gnullvm 0.52.5
  • windows_aarch64_msvc 0.52.5
  • windows_i686_gnu 0.52.5
  • windows_i686_gnullvm 0.52.5
  • windows_i686_msvc 0.52.5
  • windows_x86_64_gnu 0.52.5
  • windows_x86_64_gnullvm 0.52.5
  • windows_x86_64_msvc 0.52.5
rust/Cargo.toml cargo
pyproject.toml pypi
  • kaleido == 0.2.1
  • matplotlib ==3.7.2
  • numpy ==1.25.1
  • pandas ==2.0.3
  • plotly ==5.15.0
  • pymatgen ==2024.1.27
  • pywebview ==4.4.1
  • scipy ==1.11.1
  • toml ==0.10.2