updates metadata

.zenodo.json

@@ -1,6 +1,6 @@
 {
     "license": "CC-BY-NC-SA-4.0",
-    "description": "<p>This corpus of annotated <a href=\"https://musescore.org\">MuseScore</a> files has been created within the <a href=\"https://github.com/DCMLab/dcml_corpora\">DCML corpus initiative</a> and employs the <a href=\"https://github.com/DCMLab/standards\">DCML harmony annotation standard</a>. It is one out of nine similar corpora that have been grouped together to <a href=\"https://github.com/DCMLab/romantic_piano_corpus\">An Annotated Corpus of Tonal Piano Music from the Long 19th Century</a> which comes with a data report that is currently under review.</p>\n\n<p><strong>Version 1</strong> has been released for submitting it as part of the data report <code>Hentschel, J., Rammos, Y., Neuwirth, M., Rohrmeier, M. (forthcoming). An Annotated Corpus of Tonal Piano Music from the Long 19th Century</code> that accompanies nine corpora grouped under the DOI <a href=\"https://doi.org/10.5281/zenodo.7483349\">10.5281/zenodo.7483349</a>.</p>\n\n<p><strong>Version 1.1</strong> corrects a mistake in the <code>metadata.tsv</code> file and extracts the data with ms3 1.0.4.</p>\n\n<p><strong>Version 1.2</strong> comes with a complete set of metadata and score headers. Among more accurate composition dates, the metadata now include URIs that identify the compositions in terms of the <a href=\"https://viaf.org/\">Virtual International Authority File (VIAF)</a>, <a href=\"https://www.wikidata.org\">Wikidata</a>, <a href=\"https://imslp.org/\">IMSLP</a> and <a href=\"https://musicbrainz.org/\">MusicBrainz</a>. The data has been re-extracted from the scores using <a href=\"https://pypi.org/project/ms3/\">ms3 1.1.1</a>.</p>",
+    "description": "<p>This corpus of annotated <a href=\"https://musescore.org\">MuseScore</a> files has been created within the <a href=\"https://github.com/DCMLab/dcml_corpora\">DCML corpus initiative</a> and employs the <a href=\"https://github.com/DCMLab/standards\">DCML harmony annotation standard</a>. It is one out of nine similar corpora that have been grouped together to <a href=\"https://doi.org/10.5281/zenodo.7473560\">An Annotated Corpus of Tonal Piano Music from the Long 19th Century</a> which comes with a data report that is currently under review.</p>\n\n<p>The dataset lives on GitHub (link under &quot;Related identifiers&quot;) and is stored on Zenodo purely for conservation and automatic DOI generation for new GitHub releases. For technical reasons, we include only brief, generic instructions on how to use the data. For more detailed documentation, please refer to the dataset&#39;s GitHub page.</p>\n\n<p><strong>What is included</strong></p>\n\n<p>The dataset includes annotated MusicScores <strong>.mscx</strong> files that have been created with <a href=\"https://github.com/musescore/MuseScore/releases/tag/v3.6.2\">MuseScore 3.6.2</a> and can be opened with any MuseScore 3, or later version. Apart from that, the score information (measures, notes, harmony labels) have been extracted in the form of TSV files which can be found respectively in the folders <code>measures</code>, <code>notes</code>, and <code>harmonies</code>. They have been extracted with the Python library <a href=\"https://pypi.org/project/ms3/\">ms3</a> and its documentation has a <a href=\"https://ms3.readthedocs.io/columns\">column glossary for looking up the meaning of a column</a>.</p>\n\n<p><strong>Getting the data</strong></p>\n\n<p>You can download the dataset as a ZIP file from Zenodo or GitHub. Please note that these automatically generated ZIP files do not include submodules, which would appear as empty folders. If you need ZIP files, you will need to find the submodule repositories (e.g. via GitHub) and download them individually.</p>\n\n<p>Apart from that, there is the possibility to git-clone the GitHub repository to your disk. This has the advantage that it allows to version-control any changes you want to make to the dataset and to ask for your changes to be included (&quot;merged&quot;) in a future version.</p>",
     "contributors": [
         {
             "orcid": "0000-0002-6329-7492",
@@ -30,6 +30,9 @@
     "communities": [
         {
             "identifier": "dcml"
+        },
+        {
+            "identifier": "epfl"
         }
     ],
     "publication_date": "2022-12-22",

README.md

@@ -3,8 +3,19 @@
 ![GitHub repo size](https://img.shields.io/github/repo-size/DCMLab/liszt_pelerinage)
 ![License](https://img.shields.io/badge/license-CC%20BY--NC--SA%204.0-9cf) 
 
+This is a README file for a data repository originating from the [DCML corpus initiative](https://github.com/DCMLab/dcml_corpora)
+and serves as welcome page for both 
+
+* the GitHub repo [https://github.com/DCMLab/liszt_pelerinage](https://github.com/DCMLab/liszt_pelerinage) and the corresponding
+* documentation page [https://dcmlab.github.io/liszt_pelerinage](https://dcmlab.github.io/liszt_pelerinage)
+
+For information on how to obtain and use the dataset, please refer to [this documentation page](https://dcmlab.github.io/liszt_pelerinage/introduction).
+
+
+
 <!-- TOC -->
-* [Franz Liszt - Années de Pèlerinage (A corpus of annotated scores)](#franz-liszt---années-de-pèlerinage--a-corpus-of-annotated-scores-)
+* [Franz Liszt - Années de Pèlerinage (A corpus of annotated scores)](#franz-liszt---années-de-pèlerinage-a-corpus-of-annotated-scores)
+  * [Version history](#version-history)
   * [Getting the data](#getting-the-data)
     * [With full version history](#with-full-version-history)
     * [Without full version history](#without-full-version-history)
@@ -21,7 +32,7 @@
   * [Questions, Suggestions, Corrections, Bug Reports](#questions-suggestions-corrections-bug-reports)
   * [License](#license)
   * [Naming convention](#naming-convention)
-* [Overview](#overview)
+  * [Overview](#overview)
 <!-- TOC -->
 
 # Franz Liszt - Années de Pèlerinage (A corpus of annotated scores)
@@ -30,21 +41,12 @@ This corpus of annotated [MuseScore](https://musescore.org) files has been creat
 the [DCML corpus initiative](https://github.com/DCMLab/dcml_corpora) and employs
 the [DCML harmony annotation standard](https://github.com/DCMLab/standards). It is one out of nine similar corpora that
 have been grouped together
-to [An Annotated Corpus of Tonal Piano Music from the Long 19th Century](https://github.com/DCMLab/romantic_piano_corpus)
-which comes with a data report that is currently under review.
-
-**Version 1** has been released for submitting it as part of the data
-report `Hentschel, J., Rammos, Y., Neuwirth, M., Rohrmeier, M. (forthcoming). An Annotated Corpus of Tonal Piano Music from the Long 19th Century`
-that accompanies nine corpora grouped under the DOI [10.5281/zenodo.7483349](https://doi.org/10.5281/zenodo.7483349).
-
-**Version 1.1** corrects a mistake in the `metadata.tsv` file and extracts the data with ms3 1.0.4.
+to [An Annotated Corpus of Tonal Piano Music from the Long 19th Century](https://doi.org/10.5281/zenodo.7483349)
+which comes with a data report that is currently in press at Empirical Musicology Review.
 
-**Version 1.2** comes with a complete set of metadata and score headers. Among more accurate composition dates, the
-metadata now include URIs that identify the compositions in terms of
-the [Virtual International Authority File (VIAF)](https://viaf.org/), [Wikidata](https://www.wikidata.org), [IMSLP](https://imslp.org/)
-and [MusicBrainz](https://musicbrainz.org/). The data has been re-extracted from the scores
-using [ms3 1.1.1](https://pypi.org/project/ms3/).
+## Version history
 
+See the [GitHub releases](https://github.com/DCMLab/liszt_pelerinage/releases).
 
 ## Getting the data