This repository contains the MaRDMO-Export-Plugin for the Research Datamanagement Organizer (RDMO) developed within Task Area 4 "Interdisciplinary Mathematics" of the Mathematical Research Data Initiative (MaRDI). The plugin allows a standardized documentation of interdisciplinary workflows (Math + X), where the connection to experiments or theoretical approaches, like simulations, is possible and desired. Documented workflows can be stored locally (depreciated) or shared with other scientists on the MaRDI Portal. In the latter case a Wiki Page is created for the documented workflow and integral aspects of the workflow are integrated into the MaRDI knowledge grarph. Integration into the MaRDI knowledge graph allows specific workflow queries which are also possible through the MaRDMO plugin.
.
├── MaRDMO - Plugin Files
│ ├── citation.py - get citation from DOI and ORCID API
│ ├── apps.py - application configuration
│ ├── handlers.py - Additional Functions in background upon click
│ ├── config.py - MaRDI portal information (API,SPARQL endpoint)
│ ├── export.py - Export/Query Function
│ ├── id.py - wikibase item and property ids
│ ├── para.py - Export/Query Parameters
│ ├── providers.py - Dynamic Option Sets via Wikidata / MaRDI KG
│ ├── sparql.py - SPARQL query selection
│ └── templates
│ ├── workflowError.html - HTML Template for MaRDMO Errors
│ ├── workflowExport.html - HTML Template for MaRDMO Export
│ ├── workflowTemplate.html - HTML Template for Workflow Documentation
│ ├── workflowTemplate.md - Markdown Template for Workflow Documentation
│ ├── workflowTemplate.mediawiki - Mediawiki Template for Workflow Documentation
│ └── workflowSearch.html - HTML Template for MaRDMO Search
│
├── setup.py
│
├── README.md
│
└── LICENSE.md To use the MaRDMO-Export-Plugin at least RDMO v2.0.0 is required. Follow the installation / update instructions of RDMO if required.
Go to the rdmo-app directory of your RDMO installation. In the virtual environment of the RDMO installation install the MaRDMO-Export-Plugin:
pip install git+https://github.com/MarcoReidelbach/MaRDMO-Export-PluginTo connect the MaRDMO-Export-Plugin with the RDMO installation add the following lines to config/settings/local.py (if not already present):
from django.utils.translation import gettext_lazy as _ INSTALLED_APPS = ['MaRDMO'] + INSTALLED_APPS
PROJECT_EXPORTS += [
('mde', _('MaRDI Export/Query'), 'MaRDMO.export.MaRDIExport'),
]
OPTIONSET_PROVIDERS = [
('WikidataSearch', _('Options for Wikidata Search'), 'MaRDMO.providers.WikidataSearch'),
('ComponentSearch', _('Options for MaRDI Search'), 'MaRDMO.providers.ComponentSearch'),
('MathAreaProvider', _('Options for Math Areas'), 'MaRDMO.providers.MathAreaProvider'),
('EnvironmentProvider', _('Options for Environments'), 'MaRDMO.providers.EnvironmentProvider'),
('MethodProvider', _('Options for Methods'), 'MaRDMO.providers.MethodProvider'),
('DataProvider', _('Options for Data Sets'), 'MaRDMO.providers.DataProvider'),
('SoftwareProvider', _('Options for Software'), 'MaRDMO.providers.SoftwareProvider'),
('ResearchField', _('Options for Research Fields'), 'MaRDMO.providers.ResearchField'),
('ResearchField2', _('Options for Research Fields2'), 'MaRDMO.providers.ResearchField2'),
('ResearchProblem', _('Options for Research Problems'), 'MaRDMO.providers.ResearchProblem'),
('ResearchProblem2', _('Options for Research Problems2'), 'MaRDMO.providers.ResearchProblem2'),
('MathematicalModel', _('Options for Mathematical Models'), 'MaRDMO.providers.MathematicalModel'),
('MathematicalModel2', _('Options for Mathematical Models2'), 'MaRDMO.providers.MathematicalModel2'),
('Quantity', _('Options for Quantities'), 'MaRDMO.providers.Quantity'),
('Quantity2', _('Options for Quantities2'), 'MaRDMO.providers.Quantity2'),
('QuantityKind', _('Options for Quantity Kinds'), 'MaRDMO.providers.QuantityKind'),
('QuantityKind2', _('Options for Quantitiy Kinds2'), 'MaRDMO.providers.QuantityKind2'),
('MathematicalFormulation', _('Options for Mathematical Formulation'), 'MaRDMO.providers.MathematicalFormulation'),
('MathematicalFormulation2', _('Options for Mathematical Formulation2'), 'MaRDMO.providers.MathematicalFormulation2'),
('QuantityAndQuantityKind', _('Options for Quantity and Quantity Kind'), 'MaRDMO.providers.QuantityAndQuantityKind'),
('MathematicalTask', _('Options for Mathematical Task'), 'MaRDMO.providers.MathematicalTask'),
('MathematicalTask2', _('Options for Mathematical Task2'), 'MaRDMO.providers.MathematicalTask2'),
('AllEntities', _('Options for All Entities'), 'MaRDMO.providers.AllEntities')
]Thereby, the MaRDMO-Export-Plugin is installed and a "MaRDI Export/Query" button is added in the project view.
To add data to the MaRDI Portal, so far, a login is required. In the MaRDMO-Export-Plugin this is facilitated using a bot. To set up the bot visit the MaRDI Portal, log in with your user credentials, choose Special Pages and Bot passwords. Provide a name for the new bot, select Create, grant the bot permission for High-volume (bot) access, Edit existing pages and Create, edit, and move pages and select again Create. Thereby, a bot is created. Add its credentials to config/settigs/local.py:
lgname = 'username@botname'
lgpassword = 'password'Workflow search and local documentations are possible without login credentials. Non-MaRDI users may contact the owner of the repository to facilitate the login for MaRDI portal publication.
The MaRDMO-Export-Plugin requires the MaRDMO-Questionnaire. To get the Questionnaire clone the repository to an appropriate location:
git clone https://github.com/MarcoReidelbach/MaRDMO-Questionnaire.gitIntegrate the MaRDMO-Questionnaire into your RDMO instance through the user interface of your RDMO instance (Management -> Import -> domains.xml/options.xml/conditions.xml/questions.xml) or via
python manage.py import /path/to/MaRDMO-Questionnaire/catalog/domains.xml
python manage.py import /path/to/MaRDMO-Questionnaire/catalog/options.xml
python manage.py import /path/to/MaRDMO-Questionnaire/catalog/conditions.xml
python manage.py import /path/to/MaRDMO-Questionnaire/catalog/questions.xmlOnce the MaRDMO-Export-Plugin is set up, the Questionnaire can be used to document and query interdisciplinary workflows. Therefore, select "Create New Project" in RDMO, choose a proper project name (project name will be used as wokflow name and label in the MaRDI portal), assign the "MaRDI Workflow Documentation" catalog and select "Create Project". The project is created. On the right hand side in the "Export" category the "MaRDI Export/Query" button is located to process the completed Questionnaire.
Choose "Answer Questions" to start the interview. With the first question the Operation Modus of the MaRDMO-Export-Plugin is determined:
-
Choose "Workflow Documentation" and click on "Save and proceed". Next, decide whether the completed Questionnaire should be exported locally or publicly to the MaRDI Portal. If a public export is desired a preview of the rendered Wiki Page could be displayed. Please, check the preview before publishing the workflow on the MaRDI Portal. Once the general settings are completed the workflow will be documented by providing general information, model information, process information and reproducibility information. Upon completion return to the project page and choose "MaRDI Export/Query" to compile the answers and return it in the desired format.
-
Choose "Workflow Search" and click on "Save and proceed". Next, choose by which components (keywords of research objective, associated research disciplines, and applied mathematical models, methods, software, input or output data sets) existing workflow documentations should be searched and specify the component. Once completed, return to the project page and choose "MaRDI Export/Query". If appropriate workflow documentations are located on the MaRDI Portal, the title of the workflow and links to the corresponding Wiki Page and Knowledge Graph entry are provided.