Skip to content

Commit

Permalink
Add content -- #78
Browse files Browse the repository at this point in the history
  • Loading branch information
enridaga committed Jun 2, 2023
1 parent 011c6f1 commit d8f4afb
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 1 deletion.
1 change: 1 addition & 0 deletions VERSIONING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 6 additions & 0 deletions _data/repositories.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/"
52 changes: 52 additions & 0 deletions content/_polifonia-project/pitchcontext/README.md
Original file line number Diff line number Diff line change
@@ -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 <path_to_kern_files> -jsonpath <path_to_json_files>
```
The -- is needed to pass the following arguments to the python script.
2 changes: 1 addition & 1 deletion repositories.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit d8f4afb

Please sign in to comment.