Skip to content

MaRDMO Plugin

MaRDMO Logo by MaRDI, licensed under CC BY-NC-ND 4.0.

MaRDMO is a plugin for the Research Data Management Organiser (RDMO), developed within the Mathematical Research Data Initiative (MaRDI). It enables structured documentation and search of mathematical research artifacts through guided questionnaire interviews. Completed documentations can be exported directly to the MaRDI knowledge graph; existing entries can be queried from the MaRDI Portal, MathModDB, or MathAlgoDB and imported back into RDMO.

Catalogs

MaRDMO provides five catalogs:

Catalog Description
Algorithm Document algorithms, algorithmic tasks, implementing software, benchmarks, and publications. Based on the MathAlgoDB ontology.
Interdisciplinary Workflow Document workflows, process steps, mathematical models, methods, software, hardware, experimental devices, data sets, and publications. Based on the MaRDI standardised scheme (to some extent on the Metadata4Engineering (M4E) ontology).
Mathematical Model (detailed) Document models, mathematical formulations, quantities, quantity kinds, computational tasks, research problems, academic disciplines, and publications. Based on the MathModDB ontology.
Mathematical Model (basic) Reduced-scope model documentation using the same MathModDB ontology.
Search Query existing entries across the MaRDI Portal, MathModDB, and MathAlgoDB knowledge graphs. Results are displayed directly in RDMO.

Prerequisites

Installation

From the rdmo-app directory, install MaRDMO into the RDMO virtual environment:

pip install MaRDMO

Add the following to config/settings/local.py:

from django.utils.translation import gettext_lazy as _

INSTALLED_APPS = ['MaRDMO'] + INSTALLED_APPS

PROJECT_EXPORTS += [
    ('wikibase',        _('Export to MaRDI Portal'), 'MaRDMO.main.MaRDMOExportProvider'),
    ('wikibase-search', _('Query MaRDI Portal'),     'MaRDMO.main.MaRDMOQueryProvider'),
]

The full OPTIONSET_PROVIDERS list required for all catalog features is available in the README.

Add the following URL pattern to config/urls.py:

path('services/', include("MaRDMO.urls")),

Portal Connection

Add the following to config/settings/local.py to connect MaRDMO to the MaRDI Portal and Wikidata:

MARDMO_PROVIDER = {
    'mardi': {
        'items':               'data/items.json',
        'properties':          'data/properties.json',
        'api':                 'https://portal.mardi4nfdi.de/w/api.php',
        'sparql':              'https://query.portal.mardi4nfdi.de/sparql',
        'uri':                 'https://portal.mardi4nfdi.de',
        'oauth2_client_id':    '',
        'oauth2_client_secret': '',
    },
    'wikidata': {
        'uri':    'https://www.wikidata.org',
        'api':    'https://www.wikidata.org/w/api.php',
        'sparql': 'https://query-main.wikidata.org/sparql',
    },
}

Contact the MaRDI consortium for OAuth2 credentials.

Questionnaire Import

MaRDMO requires the MaRDMO-Questionnaire — download the Latest Release.

Import via the RDMO management interface (Management → Import) or from the command line:

python manage.py import /path/to/MaRDMO-Questionnaire/catalog/attributes.xml
python manage.py import /path/to/MaRDMO-Questionnaire/catalog/optionsets.xml
python manage.py import /path/to/MaRDMO-Questionnaire/catalog/conditions.xml
python manage.py import /path/to/MaRDMO-Questionnaire/catalog/mardmo-search-catalog.xml
python manage.py import /path/to/MaRDMO-Questionnaire/catalog/mardmo-model-catalog.xml
python manage.py import /path/to/MaRDMO-Questionnaire/catalog/mardmo-model-basics-catalog.xml
python manage.py import /path/to/MaRDMO-Questionnaire/catalog/mardmo-interdisciplinary-workflow-catalog.xml
python manage.py import /path/to/MaRDMO-Questionnaire/catalog/mardmo-algorithm-catalog.xml

Quick Start

  1. In RDMO, select Create New Project, enter a project name, and assign one of the five MaRDMO catalogs.
  2. Select Answer Questions to work through the guided interview.
  3. Once complete, return to the project page and use the Export to MaRDI Portal button (for documentation catalogs) or Query MaRDI Portal button (for the search catalog) in the Export section on the right-hand side.

Demo videos are available for model documentation and algorithm documentation.