Data

Tools

Indexes

Applications

Experiments

Open Source Science

soniscope-jupyter

jupyter notebook widget with a scatter plot and an interactive lens to enable interactive sonification

https://github.com/fhstp/soniscope-jupyter

Science Score: 65.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
    Found 4 DOI reference(s) in README
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ✓
    Institutional organization owner
    Organization fhstp has institutional domain (fhstp.ac.at)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.6%) to scientific vocabulary

Keywords

jupyter sonification visualization
Last synced: 4 months ago · JSON representation ·

Repository

jupyter notebook widget with a scatter plot and an interactive lens to enable interactive sonification

Basic Info
  • Host: GitHub
  • Owner: fhstp
  • License: mit
  • Language: TypeScript
  • Default Branch: main
  • Homepage:
  • Size: 1.41 MB
Statistics
  • Stars: 4
  • Watchers: 4
  • Forks: 2
  • Open Issues: 0
  • Releases: 3
Topics
jupyter sonification visualization
Created about 4 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

soniscope-jupyter

PyPI-Server

jupyter notebook widget with a scatter plot and an interactive lens to enable interactive sonification

Installation

You can install using pip:

bash pip install soniscope_jupyter

If you are using Jupyter Notebook 5.2 or earlier, you may also need to enable the nbextension: bash jupyter nbextension enable --py [--sys-prefix|--user|--system] soniscope_jupyter

You can upgrade using pip:

bash pip install soniscope_jupyter --upgrade --upgrade-strategy only-if-needed

Demo

Install packages: pip install jupyterlab sc3nb Download SuperCollider (version 3.12.2) from https://supercollider.github.io/download and install it.

Start Jupyter Lab: jupyter lab

Open the notebook document SoniScope.ipynb.

Run all cells from top to "Ploting the user interface".

Development Installation

Create a dev environment: bash conda create -n soniscope_jupyter-dev -c conda-forge nodejs python jupyterlab conda activate soniscope_jupyter-dev or bash python -m venv venv source venv/Scripts/activate python -m pip install -U pip setuptools pip install nodejs 'jupyterlab==3.6.5' jupyter-packaging

For a development installation the version of the python package jupyterlab and the npm package @jupyterlab/builder need to match.

Install the python. This will also build the TS package. bash pip install -e ".[test, examples]"

When developing your extensions, you need to manually enable your extensions with the notebook / lab frontend. For lab, this is done by the command:

``` jupyter labextension develop --overwrite .

npm install # this might be necessary on a fresh development install

npm run build ```

For classic notebook, you need to run:

jupyter nbextension install --sys-prefix --symlink --overwrite --py soniscope_jupyter jupyter nbextension enable --sys-prefix --py soniscope_jupyter

Note that the --symlink flag doesn't work on Windows, so you will here have to run the install command every time that you rebuild your extension. For certain installations you might also need another flag instead of --sys-prefix, but we won't cover the meaning of those flags here.

To use symlinks in Windows 10, you can turn on Windows' developer mode.

How to see your changes

Typescript:

If you use JupyterLab to develop then you can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the widget.

```bash

Watch the source directory in one terminal, automatically rebuilding when needed

npm run watch

Run JupyterLab in another terminal

jupyter lab ```

After a change wait for the build to finish and then refresh your browser and the changes should take effect.

Python:

If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.

Updating the version

To update the version, install tbump and use it to bump the version. By default it will also create a tag.

bash pip install tbump tbump <new-version>

Citation

Kajetan Enge, Alexander Rind, Michael Iber, Robert Höldrich, and Wolfgang Aigner. "Towards Multimodal Exploratory Data Analysis: SoniScope as a Prototypical Implementation". In: Proceedings of the 24th Eurographics Conference on Visualization (EuroVis) – Short Papers, p. 67-71. Rome, Eurographics Association, 2022. \ https://doi.org/10.2312/evs.20221095

Owner

  • Name: Sankt Pölten University of Applied Sciences | General
  • Login: fhstp
  • Kind: organization
  • Email: daniel.haslinger@fhstp.ac.at
  • Location: Austria

Public GitHub Repositories of the UAS St. Poelten

Citation (CITATION.cff) 

cff-version: 1.2.0
title: SoniScope
authors:
  - given-names: Alexander
    family-names: Rind
    affiliation: >-
      St. Pölten University of Applied Sciences,
      Austria
    orcid: 'https://orcid.org/0000-0001-8788-4600'
  - given-names: Kajetan
    family-names: Enge
    affiliation: >-
      St. Pölten University of Applied Sciences,
      Austria
    orcid: 'https://orcid.org/0000-0002-5456-1140'
message: >-
  Please cite this software using the metadata from
  the EuroVis 2022 conference paper in 'preferred-citation'.
type: software
preferred-citation:
  title: >-
    Towards Multimodal Exploratory Data Analysis:
    SoniScope as a Prototypical Implementation
  authors:
    - given-names: Kajetan
      family-names: Enge
      affiliation: >-
        St. Pölten University of Applied Sciences,
        Austria
      orcid: 'https://orcid.org/0000-0002-5456-1140'
    - given-names: Alexander
      family-names: Rind
      affiliation: >-
        St. Pölten University of Applied Sciences,
        Austria
      orcid: 'https://orcid.org/0000-0001-8788-4600'
    - given-names: Michael
      family-names: Iber
      affiliation: >-
        St. Pölten University of Applied Sciences,
        Austria
      orcid: 'https://orcid.org/0000-0002-5929-8716'
    - given-names: Robert
      family-names: Höldrich
      affiliation: >-
        University of Music and Performing Arts Graz,
        Austria
      orcid: 'https://orcid.org/0000-0002-6887-6637'
    - given-names: Wolfgang
      family-names: Aigner
      affiliation: >-
        St. Pölten University of Applied Sciences,
        Austria
      orcid: 'https://orcid.org/0000-0001-5762-1869'
  type: conference-paper
  conference:
    name: "Eurographics Conference on Visualization (EuroVis) – Short Papers"
  collection-title: Proceedings of the Eurographics Conference on Visualization (EuroVis) – Short Papers
  collection-type: proceedings
  year: 2022
  doi: 10.2312/evs.20221095

GitHub Events

Total
  • Watch event: 2
Last Year
  • Watch event: 2

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 86
  • Total Committers: 2
  • Avg Commits per committer: 43.0
  • Development Distribution Score (DDS): 0.035
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Alexander Rind 1****d 83
Kajetan Enge k****n@e****t 3
Committer Domains (Top 20 + Academic)
enge.at: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 hour
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
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
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • alex-rind (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 19 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 5
  • Total maintainers: 1
pypi.org: soniscope-jupyter

jupyter notebook widget with a scatter plot and an interactive lens to enable interactive sonification

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 19 Last month
Rankings
Dependent packages count: 7.6%
Forks count: 19.4%
Dependent repos count: 22.6%
Average: 26.6%
Stargazers count: 32.3%
Downloads: 50.9%
Maintainers (1)
alex.rind
Last synced: 5 months ago

Dependencies

package-lock.json npm
  • 1185 dependencies
package.json npm
  • @babel/core ^7.5.0 development
  • @babel/preset-env ^7.5.0 development
  • @jupyterlab/builder ^3.0.0 development
  • @phosphor/application ^1.6.0 development
  • @phosphor/widgets ^1.6.0 development
  • @types/d3 ^7.1.0 development
  • @types/jest ^26.0.0 development
  • @types/webpack-env ^1.13.6 development
  • @typescript-eslint/eslint-plugin ^3.6.0 development
  • @typescript-eslint/parser ^3.6.0 development
  • acorn ^7.2.0 development
  • css-loader ^6.5.1 development
  • eslint ^7.4.0 development
  • eslint-config-prettier ^6.11.0 development
  • eslint-plugin-prettier ^3.1.4 development
  • fs-extra ^7.0.0 development
  • identity-obj-proxy ^3.0.0 development
  • jest ^26.0.0 development
  • mkdirp ^0.5.1 development
  • npm-run-all ^4.1.3 development
  • prettier ^2.0.5 development
  • rimraf ^2.6.2 development
  • source-map-loader ^1.1.3 development
  • style-loader ^1.0.0 development
  • ts-jest ^26.0.0 development
  • ts-loader ^8.0.0 development
  • typescript ~4.1.3 development
  • webpack ^5.0.0 development
  • webpack-cli ^4.0.0 development
  • @jupyter-widgets/base ^1.1.10 || ^2.0.0 || ^3.0.0 || ^4.0.0
  • d3 ^7.2.1
setup.py pypi
  • ipywidgets >=7.0.0
  • numpy ==1.21.0
  • pandas >=1.3.0
.github/workflows/build.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/setup-node v1 composite
  • actions/setup-python v2 composite
pyproject.toml pypi
  • ipywidgets >=7.0.0
  • numpy >=1.21.0
  • pandas >=1.3.0
docs/environment.yml conda
  • jupyter_sphinx
  • nbsphinx
  • nbsphinx-link
  • nodejs
  • python 3.*
  • sphinx
  • sphinx_rtd_theme