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 (13.1%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: benkrikler
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: main
  • Size: 16.6 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 5
  • Releases: 0
Created over 3 years ago · Last pushed over 3 years ago
Metadata Files
Readme Contributing License Citation

README.md

wavefilter

PyPI - Version PyPI - Python Version CI <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> All Contributors <!-- ALL-CONTRIBUTORS-BADGE:END -->


Table of Contents

Overview

TODO: Give a brief explanation here

See the design choices document for more details.

Installation

console pip install wavefilter

Developing

Pre-commit tests

Static code tests and formatting checks can be run using pre-commit. Install pre-commit, then initialise the hooks for this project with: pre-commit install

When you next commit a change, pre-commit will run various formatting and static code checks, in some cases fixing any issues automatically (see e.g. black and isort).

To manually trigger these checks on all files, you can do something like:

console pre-commit run --all-files See pre-commit's built-in help for more guidance.

Unit testing

Run the built-in unit tests with pytest:

python -m pytest

Contributors

benkrikler
benkrikler

🤔 🎨 📖 ⚠️ 💻

See CONTRIBUTING.md for how to contribute.

License

wavefilter is distributed under the terms of the MIT license.

Based on python package template from https://github.com/benkrikler/mypythoncookie

Owner

  • Login: benkrikler
  • Kind: user

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: Wavefilter
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Benjamin Edward Krikler
    email: 4083697+benkrikler@users.noreply.github.com
    orcid: 'https://orcid.org/0000-0001-9712-0030'

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 8
  • Total pull requests: 10
  • Average time to close issues: 5 days
  • Average time to close pull requests: about 14 hours
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 0.75
  • Average comments per pull request: 0.0
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 6
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
  • benkrikler (7)
Pull Request Authors
  • allcontributors[bot] (3)
  • benkrikler (2)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pre-commit/action v3.0.0 composite
pyproject.toml pypi
  • matplotlib >=3.5
  • pandas ==1.3.5
  • scipy >=1.7
  • torch >=1.12
  • tqdm >=4.64