Science Score: 36.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
-
✓Committers with academic emails
3 of 4 committers (75.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.0%) to scientific vocabulary
Repository
computer-aided rhythm analysis toolbox
Basic Info
- Host: GitHub
- Owner: mrocamora
- License: mit
- Language: Python
- Default Branch: master
- Size: 223 MB
Statistics
- Stars: 35
- Watchers: 4
- Forks: 4
- Open Issues: 20
- Releases: 5
Metadata Files
README.md
carat
_ _ __ _ _|_ (_ (_| | (_| |_ computer-aided rhythm analysis toolbox
Documentation
See https://carat.readthedocs.io for a complete reference manual and introductory tutorials.
Demonstration notebooks
Some demonstrations of what you can do with carat:
- Rhythmic patterns demo notebook: how to extract rhythmic patterns from an audio recording.
- Microtiming patterns demo notebook: how to extract microtiming patterns from an audio recording.
- Onsets detection demo notebook: how to detect onsets from an audio recording.
Installation
The latest stable release is available on PyPI, and you can install it by
pip install carat
To build carat from source, use python setup.py build.
Then, to install carat, say python setup.py install.
If all went well, you should be able to execute the demo scripts under examples/
(OS X users should follow the installation guide given below).
Alternatively, you can download or clone the repository and use pip to handle dependencies:
unzip carat.zip
pip install -e carat
or
git clone https://github.com/mrocamora/carat.git
pip install -e carat
By calling pip list you should see carat now as an installed pacakge:
carat (0.x.x, /path/to/carat)
Hints for the Installation
carat uses librosa to load audio files. The following are the installation hints provided by librosa in order to install the needed dependencies to load audio files.
librosa uses soundfile and audioread to load audio files.
Note that soundfile does not currently support MP3, which will cause librosa to
fall back on the audioread library.
soundfile
If you're using pip on a Linux environment, you may need to install libsndfile
manually. Please refer to the SoundFile installation documentation for details.
audioread and MP3 support
To fuel audioread with more audio-decoding power (e.g., for reading MP3 files),
you may need to install either ffmpeg or GStreamer.
Note that on some platforms, audioread needs at least one of the programs to work properly.
Here are some common commands for different operating systems:
- Linux (apt-get):
apt-get install ffmpegorapt-get install gstreamer1.0-plugins-base gstreamer1.0-plugins-ugly - Linux (yum):
yum install ffmpegoryum install gstreamer1.0-plugins-base gstreamer1.0-plugins-ugly - Mac:
brew install ffmpegorbrew install gstreamer - Windows: download binaries from the website
For GStreamer, you also need to install the Python bindings with
pip install pygobject
Citing
If you want to cite carat please cite the paper published at AAWM 2019:
Rocamora, and Jure. "carat: Computer-Aided Rhythmic Analysis Toolbox." In Proceedings of Analytical Approaches to World Music. 2019.
Owner
- Name: Martín Rocamora
- Login: mrocamora
- Kind: user
- Location: Montevideo, Uruguay
- Website: https://iie.fing.edu.uy/~rocamora/
- Repositories: 1
- Profile: https://github.com/mrocamora
GitHub Events
Total
- Watch event: 4
- Pull request event: 1
- Fork event: 1
Last Year
- Watch event: 4
- Pull request event: 1
- Fork event: 1
Committers
Last synced: 12 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Martin Rocamora | r****a@f****y | 89 |
| Jimena Arruti | j****i@e****y | 29 |
| ivanlmh | i****n@g****m | 7 |
| luis jure | lj@e****y | 6 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 12 months ago
All Time
- Total issues: 40
- Total pull requests: 38
- Average time to close issues: about 1 month
- Average time to close pull requests: 3 days
- Total issue authors: 4
- Total pull request authors: 7
- Average comments per issue: 0.28
- Average comments per pull request: 0.18
- Merged pull requests: 32
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: 8 minutes
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- mrocamora (26)
- jimearruti (11)
- ivanlmh (2)
- luisjure (1)
Pull Request Authors
- jimearruti (18)
- mrocamora (8)
- luisjure (5)
- ivanlmh (4)
- dhunstack (2)
- satyajeetprabhu (2)
- luis-j (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 57 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 7
- Total maintainers: 2
pypi.org: carat
Computer-Aided Rhythm Analysis Toolbox
- Homepage: http://github.com/mrocamora/carat
- Documentation: https://carat.readthedocs.io/
- License: MIT
-
Latest release: 0.1.6
published over 4 years ago
Rankings
Maintainers (2)
Dependencies
- librosa >=0.8.0
- matplotlib >=2.0.0
- numpy >=1.8.0
- numpydoc >=1.1.0
- numpydoc >=0.9.1
- scikit-learn >=0.14.0
- scipy >=1.0.0
- soundfile >=0.10.2
- sphinx ==3.4.0
- sphinx-gallery >=0.4.0
- audioread *
- librosa *
- matplotlib *
- numpy *
- scikit-learn *
- scipy *
- sounddevice *
- soundfile *