lvlspy

A python package developed to handle quantum levels which can act as a basis for larger simulations

https://github.com/jaadt7/lvlspy

Science Score: 77.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
    Found 4 DOI reference(s) in README
  • Academic publication links
    Links to: aps.org, zenodo.org
  • Committers with academic emails
    2 of 3 committers (66.7%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.6%) to scientific vocabulary

Keywords

astrophysics atomic-physics nuclear-physics python3 quantum-levels
Last synced: 4 months ago · JSON representation ·

Repository

A python package developed to handle quantum levels which can act as a basis for larger simulations

Basic Info
  • Host: GitHub
  • Owner: jaadt7
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 580 KB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 1
  • Releases: 6
Topics
astrophysics atomic-physics nuclear-physics python3 quantum-levels
Created over 3 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.rst

Overview
========

lvlspy is a python package for working with quantum level-system data.

|pypi| |doc_stat| |license| |pytest| |pylint| |black| |zenodo|

Installation
------------

Install from `PyPI `_ with pip by
typing in your favorite terminal::

    $ pip install lvlspy 

If you already have installed and wish to update lvlspy to the latest version, you will have to do it via::

    $ pip install lvlspy --upgrade
    
We are working on bringing lvlspy to Anaconda. For now, you will have to use the built-in pip manager in Anaconda instead of the conda package manager. This page will be updated when the package is up on Anaconda. 
	
Usage
-----

To get familiar with lvlspy, please see our tutorial `Jupyter
notebooks `_.

This `Jupyter notebook `_ uses lvlspy to reproduce the results
found in `Gupta and Meyer `_.

Documentation
-------------

The project documentation is available at ``_.

Attribution
-----------
To cite this code, please visit the `Zenodo `_ page
for this project.  From that page, you can export the appropriate reference in BibTex or other formats.

Authors
-------

- Jaad A. Tannous 
- Bradley S. Meyer 

Contribute
----------

- Issue Tracker: ``_
- Source Code: ``_

License
-------

The project is licensed under the GNU Public License v3 (or later).

.. |pypi| image:: https://badge.fury.io/py/lvlspy.svg
    :target: https://badge.fury.io/py/lvlspy 
.. |license| image:: https://img.shields.io/github/license/jaadt7/lvlspy
    :alt: GitHub
.. |doc_stat| image:: https://readthedocs.org/projects/lvlspy/badge/?version=latest
    :target: https://lvlspy.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status
.. |pytest| image:: https://github.com/jaadt7/lvlspy/actions/workflows/test.yml/badge.svg?branch=main&event=push
	:target: https://github.com/jaadt7/lvlspy/actions/workflows/test.yml
.. |pylint| image:: https://github.com/jaadt7/lvlspy/actions/workflows/lint.yml/badge.svg?branch=main&event=push
	:target: https://github.com/jaadt7/lvlspy/actions/workflows/lint.yml 
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8193378.svg
    :target: https://doi.org/10.5281/zenodo.8193378

Owner

  • Name: Jaad Tannous
  • Login: jaadt7
  • Kind: user
  • Location: Clemson S.C.
  • Company: Clemson University

Currently a Ph.D. candidate at Clemson University. My research focus is on stellar evolution and nucleosynthesis, specifically the s-process

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Tannous"
  given-names: "Jaad Antoun"
  orcid: "https://orcid.org/0000-0002-9970-6454"
- family-names: "Meyer"
  given-names: "Bradley Stewart"
  orcid: "https://orcid.org/0000-0001-6307-9818"
title: "wnutils"
version: 4.0.0
doi: 10.5281/zenodo.8193378
date-released: 2025-02-14
url: "https://github.com/jaadt7/lvlspy"

GitHub Events

Total
  • Release event: 1
  • Delete event: 3
  • Push event: 38
  • Pull request event: 2
  • Create event: 4
Last Year
  • Release event: 1
  • Delete event: 3
  • Push event: 38
  • Pull request event: 2
  • Create event: 4

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 46
  • Total Committers: 3
  • Avg Commits per committer: 15.333
  • Development Distribution Score (DDS): 0.326
Top Committers
Name Email Commits
Bradley Meyer m****e@c****u 31
Jaad Tannous j****7@g****m 14
Bradley Meyer m****e@g****u 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 1
  • Total pull requests: 5
  • Average time to close issues: N/A
  • Average time to close pull requests: 6 days
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • mbradle (1)
Pull Request Authors
  • jaadt7 (6)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 84 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 14
  • Total maintainers: 1
pypi.org: lvlspy

Python project to work with quantum level system data

  • Versions: 14
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 84 Last month
Rankings
Dependent packages count: 6.6%
Downloads: 22.7%
Average: 25.9%
Forks count: 30.5%
Dependent repos count: 30.6%
Stargazers count: 39.1%
Maintainers (1)
Last synced: 4 months ago

Dependencies

doc/requirements.txt pypi
  • lxml *
  • numpy *
setup.py pypi
  • lxml *
.github/workflows/black.yml actions
  • actions/checkout v3 composite
  • psf/black stable composite
.github/workflows/draft-pdf.yml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v1 composite
  • openjournals/openjournals-draft-action master composite
.github/workflows/lint.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
.github/workflows/test.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite