» Dezrann corpus/developer documentation
A corpus on Dezrann should contain score(s), set(s) of analyses/annotations, synchronized audio(s) (or at least two of the three), and appropriate metadata. As far as possible, these files should be available under open-data licenses, as described on Open Science and Licenses. We try to add corpus in a reproducible way, as for the public corpora available on the platform. Data you use or you create (scores, annotations, audios, metadata) have to be available within a git or through any stable URL.
As a corpus curator/maintainer, your responsibility is mostly to
prepare, update, and maintain a corpus description file such as
metadata/my-corpus.json giving all the information and
pointing to some sources. This involves the following steps.
Before creating a corpus, test Dezrann on one piece of your own.
(most simple way) through the form at https://dezrann.net/upload
and/or starting
from the metadata/template-one-piece.json template that
is a quite short example with one piece and four sources (score, audio,
YT video, analysis). These sources are now unrelated, pick what you want
for your piece.
(Directory structure) - Start from the corpus-template
repository (you could simply clone it), or decide your own organization
of the sources.
(Sources data) - Prepare scores (preferably .mei,
but also .musicxml or other symbolic formats, processed with Verovio).
See Scores preparation; - Prepare annotation
data. This may come either from external data and converted to the
json .dez format representing
labels, or can be done later, once the scores are on Dezrann; - Prepare
audio/video and synchronization (preferably open-data
audio/video, or possibly YouTube links). The synchronization can either come from external data,
or can be done later, once the scores are on Dezrann.
(Metadata)
my-corpus.json combining corpus and piece
metadata, as described on Specifying corpus and piece
data and metadata. You can start from the template in the corpus-template
repositoryAs of 2026, uploading the corpus on the production Dezrann involves manual steps on the server.
When the metadata/my-corpus.json file is ready:
Either contact
us with the corpus description file and/or open a MR with this file
in the /metadata directory.
🏝️ And/or test directly your corpus on the Dezrann test server with:
curl -sS --request POST --url https://test-ws.dezrann.net/corpus --header 'Content-Type: multipart/form-data' --form metadata=@my-corpus.jsontools/dezrann-corpus.py script on a local or on a public
Dezrann installation. Note that the corpus has to be built and checked
on a local installation of Dezrann (or on the test server, contact us to
have an account) and before upload to the production public server.🏝️ Once the corpus is on Dezrann, in the sandbox (as for exemple on https://test.dezrann.net/~/incoming-sandbox/piece-yourname)
metadata/my-corpus.json
file, and to rebuild the corpus;(Communication, maintenance)
text, motto, availability,
status), with a few lines presenting the corpus;tools/archive.py a long-term archive (to be documented) and
upload it on a institutional repository;