thzpy

A user friendly scientific computing library for processing THz time domain spectroscopy data.

https://github.com/dotthztag/thzpy

Science Score: 26.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
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.9%) to scientific vocabulary

Keywords

spectroscopy terahertz thz thz-tds time-domain
Last synced: 9 months ago · JSON representation

Repository

A user friendly scientific computing library for processing THz time domain spectroscopy data.

Basic Info
  • Host: GitHub
  • Owner: dotTHzTAG
  • License: lgpl-3.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 354 KB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 1
  • Open Issues: 3
  • Releases: 4
Topics
spectroscopy terahertz thz thz-tds time-domain
Created about 1 year ago · Last pushed 10 months ago
Metadata Files
Readme License Citation

README.md

THzPy

THzPy is a scientific computing library for processing terahertz time-domain spectroscopy data.

The aim of this library is simplify and speed up the analysis of THz-TDS data, as well as promote the standardisation of processing methods between research groups and industry.

Development of this package is ongoing, we are in the process of adding features and support for a wider range of experimental setups and processes. If you encounter any bugs or there are any specific features you would like to see added please get in touch.

Features

  • Windowing and filtering.
  • Extraction of optical constants.
  • Spectral feature extraction. (UPCOMING)
  • Support for the DotTHz file format. (see examples/basic_thz.py for a possible application)

Usage

The package can be installed via pip:

shell pip install thzpy

The package then presents various functions to use like so:

```python from thzpy.timedomain import commonwindow from thzpy.transferfunctions import uniformslab

Apply the same hanning window to all datasets with a half-width of 15 ps.

reference, baseline = commonwindow([reference, baseline], halfwidth=15, win_func="hanning")

Calculate buffer material properties.

buffer = uniformslab(referencethickness, reference, baseline, upsampling=3, minfrequency=0.2, maxfrequency=3, allopticalconstants=True) ```

Please see the examples folder for full demonstrations of how to use the package.

Documentation

GitHub

Authors

Feedback

If you have any feedback, please reach out to us at jnw35@cam.ac.uk

License

LGPLv3

Owner

  • Name: dotTHzTAG
  • Login: dotTHzTAG
  • Kind: organization

Citation (CITATION.bib)


      

GitHub Events

Total
  • Create event: 14
  • Issues event: 7
  • Release event: 11
  • Delete event: 4
  • Issue comment event: 6
  • Member event: 1
  • Push event: 21
  • Pull request review comment event: 4
  • Pull request review event: 5
  • Pull request event: 6
  • Fork event: 1
Last Year
  • Create event: 14
  • Issues event: 7
  • Release event: 11
  • Delete event: 4
  • Issue comment event: 6
  • Member event: 1
  • Push event: 21
  • Pull request review comment event: 4
  • Pull request review event: 5
  • Pull request event: 6
  • Fork event: 1

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 4
  • Total pull requests: 4
  • Average time to close issues: 10 days
  • Average time to close pull requests: 21 days
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.25
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 4
  • Pull requests: 4
  • Average time to close issues: 10 days
  • Average time to close pull requests: 21 days
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.25
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • Chi-Ki-Leung (3)
  • dannyetobar (1)
Pull Request Authors
  • hacknus (3)
  • JasperWB (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 93 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 7
  • Total maintainers: 2
pypi.org: thzpy

Data proccessing for THz-TDS. A scientific computing package for the processing of terahertz time-domain spectroscopy data. Includes modules for time-domain, transfer functions, frequency-domain, and data formatting.

  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 93 Last month
Rankings
Dependent packages count: 9.6%
Average: 31.7%
Dependent repos count: 53.8%
Maintainers (2)
Last synced: 10 months ago

Dependencies

.github/workflows/python-publish.yml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
pyproject.toml pypi
  • numpy *
  • pydotthz >=0.4.0
requirements.txt pypi
  • matplotlib *
  • numpy *
  • pydotthz >=0.4.0