gemlog

gemlog: Data Conversion for the Open-Source Gem Infrasound Logger - Published in JOSS (2023)

https://github.com/ajakef/gemlog

Science Score: 95.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
    Found 1 DOI reference(s) in JOSS metadata
  • Academic publication links
  • Committers with academic emails
    1 of 6 committers (16.7%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

infrasound miniseed
Last synced: 6 months ago · JSON representation

Repository

Data conversion software for the Gem Infrasound Logger

Basic Info
  • Host: GitHub
  • Owner: ajakef
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 296 MB
Statistics
  • Stars: 12
  • Watchers: 4
  • Forks: 9
  • Open Issues: 5
  • Releases: 1
Topics
infrasound miniseed
Created almost 6 years ago · Last pushed 7 months ago
Metadata Files
Readme License

README.md

Installation

  • Follow the directions here.

Getting started after installing gemlog

  • Most users will only need the gemconvert tool for converting data to standard formats. gemconvert is run from the terminal. This call will give you the syntax, options, and version number. gemconvert -h # print the help page

  • Run pip install --upgrade gemlog on the command line to update gemlog to the newest version.

  • Run this demo to ensure that everything works on your system and as an example of a typical workflow.

  • If you have data files that lack GPS information (e.g., because they were recorded on a high-altitude balloon, indoors, or underground), AND you're ok with having imprecise sample timing, run this demo too.

  • If you've found a bug, please raise an issue on github. Please be sure that the conda environment is activated on your computer, that the dependencies are installed correctly, and that you're including information about your system and enough info for your issue to be reproduced. If you have an idea for an improvement, you can raise an issue for that too--especially if you're willing to implement it!

Contributing

User contributions are welcome! If you want to improve performance or address outstanding issues, please follow the guidelines below. Like any group that benefits from volunteers, we very much appreciate contributors but require that contributions follow this framework in order to be manageable.

Code requirements:
  • New functions must have docstrings (follow the format used in, for example, read_gem).
  • Variable names should have meaningful names. Single-letter exceptions: t is allowed for 'time', and p ('pressure') for infrasound time series.
  • 100-character limit per line.
  • Following normal python convention, variable names use snake_case and class names use CamelCase.
Workflow requirements for contributing:
  • Follow the installation instructions for developers in the link above.
  • If you are new to git, check out the git cheat sheet.
  • Contributing code via github pull request is required unless, for a good reason, you have a complete and significant contribution and you are totally unable to share using github. Code contributed via other channels (e.g., email) is less transparent and more burdensome on maintainers.
  • Begin your contribution by raising an issue to get quick feedback from maintainers and users.
  • Be sure you are editing the most current gemlog version!
  • After finishing your changes, commit them and push them to a gemlog fork on your github account. A suite of tests and style checks will run after the push. Your code must pass all automated checks before it can be considered for merging.
  • Send a pull request when your code is ready for review. This is often at the point when you think you're done, but it can be earlier if you need to share your code to get specific feedback.

Need help?

  • Check the demonstrations mentioned above to see if it addresses your issue.
  • Look through the issues in this github site to see if anyone else is having the same trouble you are.
  • If those don't work, email project lead Jake Anderson at jacobanderson152@boisestate.edu.

Owner

  • Name: Jake Anderson
  • Login: ajakef
  • Kind: user

JOSS Publication

gemlog: Data Conversion for the Open-Source Gem Infrasound Logger
Published
June 15, 2023
Volume 8, Issue 86, Page 5256
Authors
Jacob F. Anderson ORCID
Department of Geosciences, Boise State University, USA
Kevin S. Anderson ORCID
Independent Researcher
Tamara Beschorner ORCID
Oregon Hazards Lab, Earth Science Department, University of Oregon, USA
Editor
Brian McFee ORCID
Tags
geophysics infrasound

GitHub Events

Total
Last Year

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 531
  • Total Committers: 6
  • Avg Commits per committer: 88.5
  • Development Distribution Score (DDS): 0.136
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Jake Anderson a****f@g****m 459
Tamara s****m@l****m 60
Kevin Anderson k****o@g****m 9
SciJerryMock 7****k 1
Kevin Anderson k****n@n****v 1
JacobAnderson152 j****2@k****u 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 23
  • Total pull requests: 28
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 9 days
  • Total issue authors: 7
  • Total pull request authors: 6
  • Average comments per issue: 1.13
  • Average comments per pull request: 0.68
  • Merged pull requests: 20
  • Bot issues: 0
  • Bot pull requests: 3
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
  • ajakef (12)
  • kevinsa5 (6)
  • dannycbowman (1)
  • leighton-watson (1)
  • Patrick-Hollands (1)
  • fkdannemann (1)
Pull Request Authors
  • kevinsa5 (11)
  • TLSatterwhite (10)
  • ajakef (4)
  • dependabot[bot] (3)
  • madhunt (1)
  • SciJerryMock (1)
Top Labels
Issue Labels
enhancement (3) good first issue (1)
Pull Request Labels
dependencies (3)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 919 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 54
  • Total maintainers: 1
pypi.org: gemlog

A set of functions for processing Gem datalogger files.

  • Versions: 54
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 919 Last month
Rankings
Downloads: 4.3%
Dependent packages count: 10.0%
Forks count: 11.9%
Average: 13.1%
Stargazers count: 17.7%
Dependent repos count: 21.7%
Maintainers (1)
Last synced: 6 months ago

Dependencies

.github/workflows/build-deploy.yml actions
  • actions/checkout v2 composite
  • actions/download-artifact v2 composite
  • actions/setup-python v2 composite
  • actions/upload-artifact v2 composite
  • pypa/gh-action-pypi-publish master composite
.github/workflows/test-lint.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite