pyspeckle

Creation and Analysis of Laser Speckle

https://github.com/scottprahl/pyspeckle

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 2 DOI reference(s) in README
  • Academic publication links
    Links to: researchgate.net, zenodo.org
  • Committers with academic emails
    1 of 3 committers (33.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.9%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Creation and Analysis of Laser Speckle

Basic Info
  • Host: GitHub
  • Owner: scottprahl
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 36.4 MB
Statistics
  • Stars: 14
  • Watchers: 3
  • Forks: 5
  • Open Issues: 0
  • Releases: 5
Created almost 8 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Changelog License Citation

README.rst

.. |pypi-badge| image:: https://img.shields.io/pypi/v/pyspeckle?color=68CA66
   :target: https://pypi.org/project/pyspeckle/
   :alt: pypi

.. |github-badge| image:: https://img.shields.io/github/v/tag/scottprahl/pyspeckle?label=github&color=68CA66
   :target: https://github.com/scottprahl/pyspeckle
   :alt: github

.. |conda-badge| image:: https://img.shields.io/conda/v/conda-forge/pyspeckle?label=conda&color=68CA66
   :target: https://anaconda.org/conda-forge/pyspeckle
   :alt: conda-forge

.. |doi-badge| image:: https://zenodo.org/badge/131667397.svg
   :target: https://zenodo.org/badge/latestdoi/131667397
   :alt: doi

.. |license| image:: https://img.shields.io/github/license/scottprahl/pyspeckle?color=68CA66
   :target: https://github.com/scottprahl/pyspeckle/blob/main/LICENSE.txt
   :alt: License

.. |test-badge| image:: https://github.com/scottprahl/pyspeckle/actions/workflows/test.yaml/badge.svg
   :target: https://github.com/scottprahl/pyspeckle/actions/workflows/test.yaml
   :alt: Testing

.. |docs-badge| image:: https://readthedocs.org/projects/pyspeckle2/badge?color=68CA66
   :target: https://pyspeckle2.readthedocs.io
   :alt: Docs

.. |downloads-badge| image:: https://img.shields.io/pypi/dm/pyspeckle?color=68CA66
   :target: https://pypi.org/project/pyspeckle/
   :alt: Downloads

pyspeckle
=========

by Scott Prahl

|pypi-badge| |github-badge| |conda-badge| |doi-badge| 

|license| |test-badge| |docs-badge| |downloads-badge|

A collection of routines to track and analyze laser speckle.  This is a python
port of SimSpeckle Matlab routines described in:

    Duncan & Kirkpatrick, "Algorithms for simulation of speckle (laser and otherwise)," in SPIE Vol. 6855 (2008). `_

To cite this code, use:

     Prahl, S. (2023). pyspeckle: a python module for creation and analysis of laser speckle. (Version 0.5.1) https://doi.org/10.5281/zenodo.8311678

1D speckle
----------
.. image:: https://raw.githubusercontent.com/scottprahl/pyspeckle/main/docs/oneD_example.png
   :alt: 1D speckle plot

2D speckle
----------
.. image:: https://raw.githubusercontent.com/scottprahl/pyspeckle/main/docs/twoD_speckle.png
   :alt: 2D speckle plot

Documentation and examples for 1D, 2D, and 3D speckle are available at 

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

Use ``pip``::
    
    pip install pyspeckle

or use ``conda``::
    
    conda install -c conda-forge pyspeckle

License
-------

``pyspeckle`` is licensed under the terms of the MIT license.

Owner

  • Name: Scott Prahl
  • Login: scottprahl
  • Kind: user
  • Location: Portland, Oregon
  • Company: Oregon Institute of Technology

Citation (CITATION.cff)

authors:
- family-names: Prahl
  given-names: Scott
  orcid: https://orcid.org/0000-0003-1468-6851
cff-version: 1.2.0
date-released: '2023-09-02'
doi: 10.5281/zenodo.8311678
message: If you use this software, please cite it as below.
title: 'pyspeckle: a python module for creation and analysis of laser speckle'
url: https://zenodo.org/badge/latestdoi/131667397
version: 0.5.1

GitHub Events

Total
  • Watch event: 2
Last Year
  • Watch event: 2

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 140
  • Total Committers: 3
  • Avg Commits per committer: 46.667
  • Development Distribution Score (DDS): 0.093
Past Year
  • Commits: 44
  • Committers: 2
  • Avg Commits per committer: 22.0
  • Development Distribution Score (DDS): 0.045
Top Committers
Name Email Commits
Scott Prahl s****t@p****m 127
Work Prahl p****l@b****u 11
GitHub Action a****n@g****m 2
Committer Domains (Top 20 + Academic)

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
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 32 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 9
  • Total maintainers: 1
pypi.org: pyspeckle

Routines for analysis of laser speckle

  • Versions: 9
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 32 Last month
Rankings
Dependent packages count: 10.1%
Forks count: 14.2%
Stargazers count: 17.7%
Dependent repos count: 21.6%
Average: 24.2%
Downloads: 57.6%
Maintainers (1)
Last synced: 6 months ago

Dependencies

docs/requirements.txt pypi
  • matplotlib *
  • nbsphinx *
  • numpy *
  • pyspeckle *
  • scipy *
  • sphinx-automodapi *
  • sphinx-rtd-theme *
requirements.txt pypi
  • matplotlib *
  • numpy *
  • scipy *