From d8f4afb2f44e366573dcd1fc67966b5d34f0cf9a Mon Sep 17 00:00:00 2001 From: Enrico Daga Date: Fri, 2 Jun 2023 21:40:29 +0200 Subject: [PATCH] Add content -- #78 --- VERSIONING.md | 1 + _data/repositories.yml | 6 +++ .../_polifonia-project/pitchcontext/README.md | 52 +++++++++++++++++++ repositories.txt | 2 +- 4 files changed, 60 insertions(+), 1 deletion(-) create mode 100644 content/_polifonia-project/pitchcontext/README.md diff --git a/VERSIONING.md b/VERSIONING.md index 2da790e8..7ac90b7f 100644 --- a/VERSIONING.md +++ b/VERSIONING.md @@ -38,6 +38,7 @@ Repositories included in this version: - polifonia-project/musicbo-knowledge-graph - polifonia-project/Polifonia-Corpus - smashub/choco +- polifonia-project/pitchcontext ## v1.1 diff --git a/_data/repositories.yml b/_data/repositories.yml index ec71a7a2..a2a79f4d 100644 --- a/_data/repositories.yml +++ b/_data/repositories.yml @@ -202,3 +202,9 @@ url: "http://github.com/smashub/choco" link: "http://github.com/smashub/choco/blob/main/" raw_link: "https://raw.githubusercontent.com/smashub/choco/main/" +- repo: "polifonia-project/pitchcontext" + type: "branches" + version: "main" + url: "http://github.com/polifonia-project/pitchcontext" + link: "http://github.com/polifonia-project/pitchcontext/blob/main/" + raw_link: "https://raw.githubusercontent.com/polifonia-project/pitchcontext/main/" diff --git a/content/_polifonia-project/pitchcontext/README.md b/content/_polifonia-project/pitchcontext/README.md new file mode 100644 index 00000000..25a76869 --- /dev/null +++ b/content/_polifonia-project/pitchcontext/README.md @@ -0,0 +1,52 @@ +--- +component-id: pitchcontext +name: pitchcontext +description: Python module for melody analysis based on pitch context vectors. +type: SoftwareLibrary +release-date: 2023-04-07 +release-number: 0.1.8 +work-package: +- WP3 +pilot: +- TUNES +keywords: + - melody + - pitch analysis +changelog: +licence: +release link: +--- + + +# pitchcontext +Python module for melody analysis based on pitch context vectors. + +## Prerequisites: +- lilypond installed and in command line path. +- convert (ImageMagick) installed and in command line path. +- kernfiles and corresponding .json files with melodic features. + +## Installation +The latest release of the pitchcontext module can be installed from pypi: +``` +$ pip install pitchcontext +``` + +The development version can be installed by cloning the repository and by using the provided pyproject.toml and poetry. In root of the rep do: +``` +$ poetry install +``` +This creates a virtual environment with pitchcontext installed. + +## Examples +Requires a Python3 environment with both pitchcontext and streamlit installed. +Three examples are provided: +- apps/st_dissonance.py +- apps/st_novelty.py +- apps/st_unharmonicity.py + +To run: +``` +$ streamlit run st_dissonance.py -- -krnpath -jsonpath +``` +The -- is needed to pass the following arguments to the python script. diff --git a/repositories.txt b/repositories.txt index 4d2afd87..f4dd9524 100644 --- a/repositories.txt +++ b/repositories.txt @@ -32,4 +32,4 @@ polifonia-project/broadcast-concerts-knowledge-graph:branches:main polifonia-project/musicbo-knowledge-graph:branches:main polifonia-project/Polifonia-Corpus:branches:master smashub/choco:branches:main - +polifonia-project/pitchcontext:branches:main