parrot

A Python software to process and average continuously recorded THz data

https://github.com/puls-lab/parrot

Science Score: 44.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
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (8.1%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

A Python software to process and average continuously recorded THz data

Basic Info
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 0
Created almost 3 years ago · Last pushed 7 months ago
Metadata Files
Readme License Citation

README.md

parrot 🦜

parrot stands for Processing All Rapidly & Reliably Obtained THz-traces.

parrot is a Python package to load, process, and plot continuously recorded THz data (along with delay line position data), obtained with electro-optic sampling (EOS), photoconductive antenna (PCA) receivers or similar techniques.

The documentation of parrot can be found here.


How to install

If you have Python/pip installed, just enter:

python pip install parrot

and it should install correctly. Otherwise, just download the repository on GitHub.


How to use

Go to GitHub and look at the files placed in the root directory. If you have Anaconda (or Python + Jupyter notebook) installed, try the Example.ipynb notebook in the root directory. If you prefer classic Python, check out Example_compact.py in the root directory. The distribution comes with some example data that allows you to see the capabilities of parrot.


Further information

Check out the documentation here.


I have a problem / I have an idea / I found a bug

Please open an issue on GitHub.

Owner

  • Name: PULS-lab
  • Login: puls-lab
  • Kind: user
  • Location: Bochum, Germany

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: parrot
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Tim
    family-names: Vogel
    email: Tim.Vogel-u81@ruhr-uni-bochum.de
    affiliation: Photonics and Ultrafast Laser Science (PULS)
    orcid: 'https://orcid.org/0000-0002-2344-1525'
repository-code: 'https://github.com/puls-lab/parrot'
abstract: >-
  parrot is a Python software to process and average
  continuously recorded THz data.
keywords:
  - Terahertz
  - THz
  - dataprocessing
  - dynamic range
  - DR
  - signal-to-noise ratio
  - SNR
  - averaging
license: GPL-3.0-or-later

GitHub Events

Total
  • Push event: 1
Last Year
  • Push event: 1

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 1,609 last-month
  • Total dependent packages: 2
  • Total dependent repositories: 3
  • Total versions: 17
  • Total maintainers: 2
pypi.org: parrot

parrot is able to to process and average continuously recorded THz data.

  • Versions: 17
  • Dependent Packages: 2
  • Dependent Repositories: 3
  • Downloads: 1,609 Last month
Rankings
Dependent repos count: 9.0%
Dependent packages count: 10.0%
Average: 10.9%
Downloads: 13.7%
Maintainers (2)
Last synced: 6 months ago

Dependencies

.github/workflows/ci.yml actions
  • actions/cache v4 composite
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
pyproject.toml pypi
  • colorama >=0.4.6
  • h5py *
  • matplotlib *
  • numpy *
  • scipy *
environment.yml pypi