astronify

Astronomical data sonification.

https://github.com/spacetelescope/astronify

Science Score: 62.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
  • Committers with academic emails
    4 of 8 committers (50.0%) from academic institutions
  • Institutional organization owner
    Organization spacetelescope has institutional domain (www.stsci.edu)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.1%) to scientific vocabulary

Keywords

astronomy sonification
Last synced: 6 months ago · JSON representation ·

Repository

Astronomical data sonification.

Basic Info
Statistics
  • Stars: 81
  • Watchers: 10
  • Forks: 17
  • Open Issues: 38
  • Releases: 0
Topics
astronomy sonification
Created almost 6 years ago · Last pushed 11 months ago
Metadata Files
Readme Changelog License Citation Codeowners

README.rst

.. image:: docs/_static/astronify-TEXT.png
    :width: 800
    :alt: Astronify logo

Sonification of astronomical data.
----------------------------------

.. image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
    :target: http://www.astropy.org
    :alt: Powered by Astropy Badge

.. image:: https://badge.fury.io/py/astronify.svg
    :target: https://badge.fury.io/py/astronify 
    :alt: PyPi Status
          
.. image:: https://readthedocs.org/projects/astronify/badge/?version=latest
    :target: https://astronify.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://img.shields.io/badge/ascl-2408.005-blue.svg?colorB=262255
    :target: https://ascl.net/2408.005
    :alt: ascl:2408.005
    
Tools for sonifying astronomical data.

This package is currently in the very beginning stages and is under active development to
include sonification of time series data, specifically light curves. 

Project Status
--------------

.. image:: https://github.com/spacetelescope/astronify/workflows/CI/badge.svg
    :target: https://github.com/spacetelescope/astronify/actions
    :alt: Astronify's GitHub Actions CI Status
    
.. image:: https://codecov.io/gh/spacetelescope/astronify/branch/main/graph/badge.svg
  :target: https://codecov.io/gh/spacetelescope/astronify
  :alt: Astronify's Codecov coverage status

Getting Started
---------------
Install instructions: https://astronify.readthedocs.io/en/latest/astronify/install.html

Tutorials: https://astronify.readthedocs.io/en/latest/astronify/tutorials.html

Contributing
------------

If you are a maintainer of the code, refer to the developer
documentation (DEVELOPER_DOC.rst file) for guidelines on how to release a
new version.

We love contributions! Astronify is open source,
built on open source, and we'd love to have you hang out in our community.

**Imposter syndrome disclaimer**: We want your help. No, really.

There may be a little voice inside your head that is telling you that you're not
ready to be an open source contributor; that your skills aren't nearly good
enough to contribute. What could you possibly offer a project like this one?

We assure you - the little voice in your head is wrong. If you can write code at
all, you can contribute code to open source. Contributing to open source
projects is a fantastic way to advance one's coding skills. Writing perfect code
isn't the measure of a good developer (that would disqualify all of us!); it's
trying to create something, making mistakes, and learning from those
mistakes. That's how we all improve, and we are happy to help others learn.

Being an open source contributor doesn't just mean writing code either. You can
help out by writing documentation, tests, or even giving feedback about the
project (and yes - that includes giving feedback about the contribution
process). Some of these contributions may be the most valuable to the project as
a whole, because you're coming to the project with fresh eyes, so you can see
the errors and assumptions that seasoned contributors have glossed over.

Note: This disclaimer was originally written by
`Adrienne Lowe `_ for a
`PyCon talk `_, and was adapted by
Astronify based on its use in the README file for the
`MetPy project `_.


License
-------

This project is Copyright (c) Clara Brasseur, Scott Fleming, Jennifer Kotler, Kate Meredith and licensed under
the terms of the BSD 3-Clause license. This package is based upon
the `Astropy package template `_
which is licensed under the BSD 3-clause licence. See the licenses folder for
more information.

Owner

  • Name: Space Telescope Science Institute
  • Login: spacetelescope
  • Kind: organization
  • Email: help@stsci.edu
  • Location: Baltimore, MD

STScI is operated by AURA for NASA

Citation (CITATION.cff)

cff-version: 1.1.0
message: "Please cite the following works when using this software: https://ui.adsabs.harvard.edu/abs/2024ascl.soft08005B"
authors:
- family-names: Brasseur
  given-names: C. E.
- family-names: Fleming
  given-names: S.
- family-names: Kotler
  given-names: J.
- family-names: Meredith  
  given-names: K.  
- family-names: Medina
  given-names: J.
- family-names: Lim 
  given-names: P.-L.
title: "Astronify: Astronomical data sonification"
version: 0.11.1
date-released: 2025-02-14
identifiers:
 - type: "ascl-id"
   value: "2408.005"
 - type: "bibcode"
   value: "2024ascl.soft08005B"
abstract: "Astronify contains tools for sonifying astronomical data, specifically data series. Data series sonification takes a data table and maps one column to time, and one column to pitch. This technique is commonly used to sonify light curves, where observation time is scaled to listening time and flux is mapped to pitch. While Astronify’s sonification uses the columns “time” and “flux” by default, any two columns can be supplied and a sonification created."

GitHub Events

Total
  • Issues event: 19
  • Watch event: 8
  • Delete event: 5
  • Issue comment event: 13
  • Push event: 81
  • Pull request review comment event: 9
  • Pull request review event: 15
  • Pull request event: 21
  • Fork event: 2
  • Create event: 5
Last Year
  • Issues event: 19
  • Watch event: 8
  • Delete event: 5
  • Issue comment event: 13
  • Push event: 81
  • Pull request review comment event: 9
  • Pull request review event: 15
  • Pull request event: 21
  • Fork event: 2
  • Create event: 5

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 83
  • Total Committers: 8
  • Avg Commits per committer: 10.375
  • Development Distribution Score (DDS): 0.59
Top Committers
Name Email Commits
Clara Brasseur c****r@s****u 34
Scott Fleming f****g@s****u 22
Jennifer Kotler j****r@s****u 12
C. E. Brasseur c****r@g****m 4
theresa dower d****r@s****u 4
Daniela Huppenkothen d****n@s****l 3
Chris Barnes c****7@g****m 2
P. L. Lim 2****m@u****m 2
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 57
  • Total pull requests: 43
  • Average time to close issues: 6 months
  • Average time to close pull requests: about 2 months
  • Total issue authors: 12
  • Total pull request authors: 11
  • Average comments per issue: 0.84
  • Average comments per pull request: 0.91
  • Merged pull requests: 34
  • Bot issues: 0
  • Bot pull requests: 3
Past Year
  • Issues: 12
  • Pull requests: 9
  • Average time to close issues: 3 months
  • Average time to close pull requests: 19 days
  • Issue authors: 5
  • Pull request authors: 4
  • Average comments per issue: 0.58
  • Average comments per pull request: 0.44
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 3
Top Authors
Issue Authors
  • ceb8 (18)
  • scfleming (15)
  • Jenneh (8)
  • jaymedina (6)
  • pllim (2)
  • thorwhalen (2)
  • HarryAddison (1)
  • folsomcp (1)
  • GabrieleBattaglia (1)
  • rdzudzar (1)
  • plazas (1)
Pull Request Authors
  • ceb8 (10)
  • Jenneh (7)
  • scfleming (6)
  • pllim (6)
  • dependabot[bot] (3)
  • NV-Codes (2)
  • thorwhalen (2)
  • theresadower (2)
  • jaymedina (2)
  • OutdatedPine906 (2)
  • dhuppenkothen (1)
Top Labels
Issue Labels
enhancement (14) bug (12) MVP (9) RIT FOSS Class (7) documentation (4) simulator (4) Testing (3) Priority: Low (1) Priority: Medium (1)
Pull Request Labels
dependencies (3) enhancement (2) MVP (2) github_actions (2) bug (1) simulator (1) documentation (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 25 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 2
  • Total maintainers: 4
pypi.org: astronify

Sonification of astronomical data.

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 25 Last month
Rankings
Stargazers count: 8.4%
Forks count: 9.6%
Dependent packages count: 10.0%
Average: 16.5%
Dependent repos count: 21.7%
Downloads: 32.8%
Last synced: 7 months ago

Dependencies

.github/workflows/ci_workflows.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • codecov/codecov-action v2 composite