Skip to content

Commit

Permalink
Merge branch 'main' of github.com:DIDONEproject/musiF
Browse files Browse the repository at this point in the history
  • Loading branch information
martianbug committed Dec 27, 2023
2 parents 70c5586 + 4ab9669 commit f235488
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,25 @@
Python library for **Music Feature Extraction and Analysis**, developed by the [Didone Project](https://didone.eu/).

### Documentation
Tho read the documentation, please see the website at: https://musif.didone.eu
Includes definitions for musif's functions and classes, definitions for all type sof features that musif extracts, as well as example code for using musif.
To read the documentation, please see the website at: https://musif.didone.eu
Includes definitions for musif's functions and classes, definitions for all types of features that musif extracts, as well as example code for using musif.

You will find also two tutorials:
- A basic Tutorial, to jus tstart using musif and extracting some features and even running some ML experiments with them.
- A basic Tutorial, to just start using musif and extracting some features and even running some ML experiments with them.
- An Advanced Tutorial, to extract features of different corpora and create your own hooks and features.

### Installation
To install the latest version of musif, just run
`pip install musif`
which will download musif and all its necessary dependencies.

## music21 and jsymbollic features
## music21 and jSymbolic features
Currently, musif is able to process and integrate basic music21 features.

For jsymbollic features, musif currently does not support the integration of these features, but a tutorial will be provided to manually merge them into musif's dataframe.
# jsymbollic installation
Java JRE >= 8 must be installed in your OS. Download Java Development Kit: https://www.oracle.com/es/java/technologies/downloads/
For jSymbolic features, musif currently does not support the integration of these features, but a tutorial will be provided to manually merge them into musif's dataframe.

#### jSymbolic installation
Java JRE >= 8 must be installed in your OS. Download jSymbolic from https://sourceforge.net/projects/jmir/files/jSymbolic/

*Important*: right now music21 features are NOT guaranteed to be compatible with musif's cache system. Native musif's features work with cache system just fine.

Expand All @@ -37,7 +38,7 @@ https://github.com/DIDONEproject/music_symbolic_features
## Changelog

#### v1.2
* Remove musif's native support on jsymbollic features. Add notebook to extract them independently
* Remove musif's native support on jSymbolic features. Add notebook to extract them independently
* Improve documentation
* fix bug on previous release

Expand Down
4 changes: 2 additions & 2 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ layout: default
---
Getting started <Tutorial>
Getting advanced <Tutorial poprock>
Comman Line Interface (CLI) <CLI>
Command Line Interface (CLI) <CLI>
File_loading
Feature_definition
Custom_features
Expand All @@ -21,7 +21,7 @@ General index <genindex>
Module index <modindex>
Search <search>
[Source code](https://github.com/DIDONEproject/musif/)
Source code <https://github.com/DIDONEproject/musif/>
```
`musif` is a Python module for computing features from music scores. It has been designed and extensively used by the [Didone](https://didone.eu) team for analyzing arias from 18th-century Italian operas on texts by Pietro Metastasio.

Expand Down

0 comments on commit f235488

Please sign in to comment.