Skip to content

Commit 61bc9dd

Browse files
authored
Update README.md
1 parent 9dcafb4 commit 61bc9dd

File tree

1 file changed

+24
-26
lines changed

1 file changed

+24
-26
lines changed

README.md

Lines changed: 24 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
[![CI](https://github.com/fourMs/MGT-python/actions/workflows/ci.yml/badge.svg)](https://github.com/fourMs/MGT-python/actions/workflows/ci.yml)
66
[![Documentation](https://github.com/fourMs/MGT-python/actions/workflows/docs.yml/badge.svg)](https://fourms.github.io/MGT-python/)
77

8-
The **Musical Gestures Toolbox for Python** is a comprehensive collection of tools for visualization and analysis of audio and video, with a focus on motion capture and musical gesture analysis.
8+
The **Musical Gestures Toolbox for Python** is a collection of tools for visualizing and analysing audio and video files.
99

1010
![MGT python](https://raw.githubusercontent.com/fourMs/MGT-python/master/musicalgestures/documentation/figures/promo/ipython_example.gif)
1111

12-
📖 **[📚 Full Documentation & Examples](https://fourms.github.io/MGT-python/)**
12+
📖 **[Documentation & Examples](https://fourms.github.io/MGT-python/)**
1313

1414
## Quick Start
1515

@@ -25,66 +25,64 @@ pip install musicalgestures
2525
import musicalgestures as mg
2626

2727
# Load a video
28-
mv = mg.MgVideo('dance.avi')
29-
30-
# Perform motion analysis
31-
motion = mv.motion()
28+
v = mg.MgVideo('dance.avi')
3229

3330
# Create visualizations
34-
motiongrams = mv.motiongrams()
35-
average = mv.average()
31+
v.grid()
32+
v.videograms()
33+
v.average()
34+
v.history()
35+
36+
# Perform motion analysis
37+
v.motion()
3638

3739
# Audio analysis
38-
spectrogram = mv.audio.spectrogram()
40+
v.audio.waveform()
41+
v.audio.spectrogram()
42+
v.audio.tempogram()
3943
```
4044

4145
### Try Online
4246

4347
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/fourMs/MGT-python/blob/master/musicalgestures/MusicalGesturesToolbox.ipynb)
4448

45-
## Documentation
46-
47-
📚 **Complete documentation is available at: [https://fourms.github.io/MGT-python/](https://fourms.github.io/MGT-python/)**
48-
4949
### Quick Links
5050

51-
- **[Installation Guide](docs/installation.md)** - Setup instructions
52-
- **[Quick Start Tutorial](docs/quickstart.md)** - Get started in minutes
53-
- **[Examples & Tutorials](docs/examples.md)** - Comprehensive examples
54-
- **[User Guide](docs/user-guide/core-classes.md)** - Detailed documentation
55-
- **[API Reference](docs/musicalgestures/index.md)** - Complete API docs
56-
- **[Contributing](docs/contributing.md)** - How to contribute
51+
- [Installation Guide](docs/installation.md)
52+
- [Quick Start Tutorial](docs/quickstart.md)
53+
- [Examples & Tutorials](docs/examples.md)
54+
- [User Guide](docs/user-guide/core-classes.md)
55+
- [API Reference](docs/musicalgestures/index.md)
56+
- [Contributing](docs/contributing.md)
5757

5858
## Features
5959

6060
- **Video Analysis**: Motion detection, optical flow, pose estimation
6161
- **Audio Processing**: Spectrograms, audio descriptors, tempo analysis
6262
- **Visualizations**: Motiongrams, videograms, motion history
63-
- **Integration**: Works with NumPy, SciPy, Matplotlib ecosystem
63+
- **Integration**: Works with NumPy, SciPy, and Matplotlib ecosystems
6464
- **Cross-platform**: Linux, macOS, Windows support
6565

6666
## Requirements
6767

6868
- Python 3.7+
69-
- FFmpeg (for video processing)
69+
- FFmpeg
7070
- See [installation guide](docs/installation.md) for complete requirements
7171

7272
## Research Background
7373

74-
This toolbox builds on the [Musical Gestures Toolbox for Matlab](https://github.com/fourMs/MGT-matlab/), which again builds on the [Musical Gestures Toolbox for Max](https://www.uio.no/ritmo/english/research/labs/fourms/software/musicalgesturestoolbox/mgt-max/).
74+
This toolbox builds on the [Musical Gestures Toolbox for Matlab](https://github.com/fourMs/MGT-matlab/), which again builds on the [Musical Gestures Toolbox for Max](https://www.uio.no/ritmo/english/research/labs/fourms/software/musicalgesturestoolbox/mgt-max/). Many researchers and research assistants have helped its development over the years, including [Balint Laczko](https://github.com/balintlaczko), [Joachim Poutaraud](https://github.com/joachimpoutaraud), [Frida Furmyr](https://github.com/fridafu), [Marcus Widmer](https://github.com/marcuswidmer), [Alexander Refsum Jensenius](https://github.com/alexarje/)
7575

7676
The software is currently maintained by the [fourMs lab](https://github.com/fourMs) at [RITMO Centre for Interdisciplinary Studies in Rhythm, Time and Motion](https://www.uio.no/ritmo/english/) at the University of Oslo.
7777

78+
[![nordicsmc2021-thumbnail_640](https://github.com/user-attachments/assets/150b1143-0730-4083-af52-8c062a080deb)](https://www.youtube.com/watch?v=tZVX_lDFrwc)
79+
7880
## Reference
7981

8082
If you use this toolbox in your research, please cite this article:
8183

8284
- Laczkó, B., & Jensenius, A. R. (2021). [Reflections on the Development of the Musical Gestures Toolbox for Python](https://www.duo.uio.no/bitstream/handle/10852/89331/Laczk%25C3%25B3_et_al_2021_Reflections_on_the_Development_of_the.pdf?sequence=2&isAllowed=y). *Proceedings of the Nordic Sound and Music Computing Conference*, Copenhagen.
8385

84-
## Credits
85-
86-
Developers: [Balint Laczko](https://github.com/balintlaczko), [Joachim Poutaraud](https://github.com/joachimpoutaraud), [Frida Furmyr](https://github.com/fridafu), [Marcus Widmer](https://github.com/marcuswidmer), [Alexander Refsum Jensenius](https://github.com/alexarje/)
87-
8886
## License
8987

9088
This toolbox is released under the [GNU General Public License 3.0 license](https://www.gnu.org/licenses/gpl-3.0.en.html).

0 commit comments

Comments
 (0)