Merge pull request #169 from CPJKU/develop

Release 1.1.1

.github/workflows/partitura_unittests.yml

@@ -2,9 +2,9 @@ name: Partitura Unittests
 
 on:
   push:
-    branches: [master, develop]
+    branches: [main, develop]
   pull_request:
-    branches: [master, develop]
+    branches: [develop]
 
 jobs:
   test:

.readthedocs.yml

@@ -0,0 +1,21 @@
+
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+   os: ubuntu-20.04
+   tools:
+     python: "3.8"
+
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: docs/requirements.txt

CHANGES.md

@@ -1,6 +1,29 @@
 Release Notes
 =============
 
+
+Version 1.1.1 (Released on 2022-10-31)
+--------------------------------------
+
+New features:
+
+* New minor feature : Adding midi pitch to freq for synthesizer add reference-based midi pitch to freq #163
+
+Bug fixes:
+
+* Documentation Fix of ReadTheDocs
+* Bug fix Bug synthesizing scores with pickup measures #166 Synthesizing score with pick up measure
+* Bug Fix of kern import Kern import fix #160
+* Bug Fix of Musicxml import repeat infer Bug with musicxml Import #161
+* Bug fix Note array with empty voice Note array from note list with empty voice bug. #159
+* Fix synthesizing scores with pickup measures #167
+
+Other changes:
+
+* Encoding declaration on all files.
+* Renaming master branch as main
+
+
 Version 1.0.0 (Released on 2022-09-20)
 --------------------------------------
 

README.md

@@ -241,8 +241,8 @@ agreement No. 670035 project ["Con Espressione"](https://www.jku.at/en/institute
 and the Austrian Science Fund (FWF) under grant P 29840-G26 (project
 ["Computer-assisted Analysis of Herbert von Karajan's Musical Conducting Style"](https://karajan-research.org/programs/musical-interpretation-karajan))
 <p align="center">
-    <img src="./docs/images/aknowledge_logo.png#gh-light-mode-only" height="200">
-    <img src="./docs/images/aknowledge_logo_negative.png#gh-dark-mode-only" height="200">
+    <img src="docs/source/images/aknowledge_logo.png#gh-light-mode-only" height="200">
+    <img src="docs/source/images/aknowledge_logo_negative.png#gh-dark-mode-only" height="200">
 </p>
 
 [//]: # ()

docs/Makefile

@@ -5,8 +5,8 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
-BUILDDIR      = _build
+SOURCEDIR     = source
+BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".
 help:

docs/make.bat

@@ -1,35 +1,35 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=.
-set BUILDDIR=_build
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
-	exit /b 1
-)
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-
-:end
-popd
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,3 @@
+partitura
+sphinx>=5
+nbsphinx

docs/Tutorial/notebook.ipynb → docs/source/Tutorial/notebook.ipynb

@@ -39,41 +39,29 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "id": "facial-quarterly",
    "metadata": {
     "colab": {
      "base_uri": "https://localhost:8080/"
     },
     "id": "PeabdL1k7YC4",
     "outputId": "fcb7d1be-27a1-4c79-c5d3-8cbfa54cae44",
-    "scrolled": true
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Requirement already satisfied: partitura in /home/manos/Desktop/JKU/codes/partitura (1.0.0)\r\n",
-      "Requirement already satisfied: numpy in /home/manos/miniconda3/envs/partitura/lib/python3.8/site-packages (from partitura) (1.21.2)\r\n",
-      "Requirement already satisfied: scipy in /home/manos/miniconda3/envs/partitura/lib/python3.8/site-packages (from partitura) (1.7.1)\r\n",
-      "Requirement already satisfied: lxml in /home/manos/miniconda3/envs/partitura/lib/python3.8/site-packages (from partitura) (4.6.3)\r\n",
-      "Requirement already satisfied: lark-parser in /home/manos/miniconda3/envs/partitura/lib/python3.8/site-packages (from partitura) (0.12.0)\r\n",
-      "Requirement already satisfied: xmlschema in /home/manos/miniconda3/envs/partitura/lib/python3.8/site-packages (from partitura) (1.8.0)\r\n",
-      "Requirement already satisfied: mido in /home/manos/miniconda3/envs/partitura/lib/python3.8/site-packages (from partitura) (1.2.10)\r\n",
-      "Requirement already satisfied: elementpath<3.0.0,>=2.2.2 in /home/manos/miniconda3/envs/partitura/lib/python3.8/site-packages (from xmlschema->partitura) (2.3.2)\r\n",
-      "fatal: destination path 'partitura_tutorial' already exists and is not an empty directory.\r\n"
-     ]
+    "scrolled": true,
+    "pycharm": {
+     "is_executing": true
     }
-   ],
+   },
+   "outputs": [],
    "source": [
     "# Install partitura\n",
     "! pip install partitura\n",
     "    \n",
     "# To be able to access helper modules in the repo for this tutorial\n",
     "# (not necessary if the jupyter notebook is run locally instead of google colab)\n",
     "!git clone https://github.com/CPJKU/partitura_tutorial.git\n",
-    "    \n",
+    "import warnings\n",
+    "warnings.filterwarnings('ignore')\n",
     "import sys, os\n",
     "sys.path.insert(0, os.path.join(os.getcwd(), \"partitura_tutorial\", \"content\"))\n",
     "sys.path.insert(0,'/content/partitura_tutorial/content')\n"
@@ -122,7 +110,7 @@
       "application/vnd.jupyter.widget-view+json": {
        "version_major": 2,
        "version_minor": 0,
-       "model_id": "6918ecbb7839408cb384594317cddb27"
+       "model_id": "51b999065d4e4460b960ff64e7507006"
       }
      },
      "metadata": {},
@@ -319,7 +307,7 @@
    "outputs": [
     {
      "data": {
-      "text/plain": "[<partitura.score.Note at 0x7fdb59595430>,\n <partitura.score.Note at 0x7fdb59595c40>,\n <partitura.score.Note at 0x7fdb59595ca0>]"
+      "text/plain": "[<partitura.score.Note at 0x7fb004c3bc70>,\n <partitura.score.Note at 0x7fb0048fb790>,\n <partitura.score.Note at 0x7fb0048fb7f0>]"
      },
      "execution_count": 5,
      "metadata": {},
@@ -839,16 +827,7 @@
    "execution_count": 26,
    "id": "passing-lending",
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "/home/manos/Desktop/JKU/codes/partitura/partitura/io/importmidi.py:128: UserWarning: change of Tempo to mpq = 500000  and resulting seconds per tick = 0.000125at time: 0.0\n",
-      "  warnings.warn(\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "# Note array from a performance\n",
     "\n",
@@ -912,11 +891,11 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "[(5.6075 , 5.5025 , 72, 37, 1, 0, 'n0')\n",
-      " (5.63375, 5.47625, 60, 27, 1, 0, 'n1')\n",
-      " (6.07   , 5.04   , 72, 45, 1, 0, 'n2')\n",
-      " (6.11125, 4.99875, 60, 26, 1, 0, 'n3')\n",
-      " (6.82625, 4.28375, 60, 39, 1, 0, 'n4')]\n"
+      "[(5.6075 , 5.5025 , 72, 37, 0, 0, 'n0')\n",
+      " (5.63375, 5.47625, 60, 27, 0, 0, 'n1')\n",
+      " (6.07   , 5.04   , 72, 45, 0, 0, 'n2')\n",
+      " (6.11125, 4.99875, 60, 26, 0, 0, 'n3')\n",
+      " (6.82625, 4.28375, 60, 39, 0, 0, 'n4')]\n"
      ]
     }
    ],
@@ -1089,14 +1068,6 @@
      "text": [
       "[(0.25, 47, 1) (1.25, 47, 1) (2.25, 47, 1) (3.  , 68, 1) (3.25, 47, 1)]\n"
      ]
-    },
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "/home/manos/Desktop/JKU/codes/partitura/partitura/directions.py:533: UserWarning: error parsing \"ritenuto\" (UnexpectedCharacters)\n",
-      "  warnings.warn('error parsing \"{}\" ({})'.format(string, type(e).__name__))\n"
-     ]
     }
    ],
    "source": [
@@ -1354,16 +1325,7 @@
    "execution_count": 40,
    "id": "rolled-cloud",
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "/tmp/ipykernel_907569/209301002.py:4: DeprecationWarning: `create_part` is deprecated as an argument to `load_match`; use `create_score` instead.\n",
-      "  performed_part, alignment, score_part = pt.load_match(match_fn, create_part=True)\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "# path to the match\n",
     "match_fn = os.path.join(MATCH_DIR, 'Chopin_op10_no3_p01.match')\n",
@@ -1567,7 +1529,7 @@
     "\n",
     "Thank you for trying out partitura! We hope it serves you well. \n",
     "\n",
-    "If you miss a particular functionality or encounter a bug, we appreciate it if you raise an issue on github: https://github.com/CPJKU/partitura/issues"
+    "If you miss a particular functionality or encounter a bug, we appreciate it if you raise an issue on GitHub: https://github.com/CPJKU/partitura/issues"
    ]
   }
  ],

docs/conf.py → docs/source/conf.py

@@ -14,7 +14,7 @@
 import sys
 import pkg_resources
 
-sys.path.insert(0, os.path.abspath("../partitura"))
+sys.path.insert(0, os.path.abspath("../../partitura"))
 # The master toctree document.
 master_doc = "index"
 
@@ -29,9 +29,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = "1.1.0" # pkg_resources.get_distribution("partitura").version
+version = "1.1.1" # pkg_resources.get_distribution("partitura").version
 # The full version, including alpha/beta/rc tags.
-release = "1.1.0"
+release = "1.1.1"
 
 # # The full version, including alpha/beta/rc tags
 # release = pkg_resources.get_distribution("partitura").version

partitura/__init__.py

@@ -1,7 +1,9 @@
-"""The top level of the package contains functions to load and save
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+"""
+The top level of the package contains functions to load and save
 data, display rendered scores, and functions to estimate pitch
 spelling, voice assignment, and key signature.
-
 """
 
 import pkg_resources

partitura/directions.py

@@ -1,12 +1,12 @@
 #!/usr/bin/env python
-
+# -*- coding: utf-8 -*-
 """
-Parse textual directions that occur in a score (in a MusicXML they are
-encoded as <words></words>), and if possible, convert them to a specific
-score.Direction class or subclass. For example "cresc." will produce a
-`score.DynamicLoudnessDirection` instance, and "Allegro molto" will produce a
-`score.ConstantTempoDirection` instance. If the meaning of the direction cannot
-be inferred, a `score.Words` instance is returned.
+This module contains methods to Parse textual directions that occur in a score
+(in a MusicXML they are encoded as <words></words>), and if possible, convert
+them to a specific score.Direction class or subclass. For example "cresc." will
+produce a `score.DynamicLoudnessDirection` instance, and "Allegro molto" will
+produce a `score.ConstantTempoDirection` instance. If the meaning of the
+direction cannot be inferred, a `score.Words` instance is returned.
 
 The functionality is provided by the function `parse_words`
 """

partitura/display.py

@@ -1,9 +1,9 @@
 #!/usr/bin/env python
-
-"""This module defines a function "show" that creates a rendering of one
+# -*- coding: utf-8 -*-
+"""
+This module defines a function "show" that creates a rendering of one
 or more parts or partgroups and opens it using the desktop default
 application.
-
 """
 
 import platform

partitura/io/__init__.py

@@ -1,3 +1,8 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+"""
+This module contains methods for importing and exporting symbolic music formats.
+"""
 from typing import Union
 
 from .importmusicxml import load_musicxml