Skip to content

Search

Search sub-package for MaRDMO.

Provides search functionality across mathematical models, algorithms, and interdisciplinary workflows stored in the MaRDI Portal:

  • :mod:~MaRDMO.search.providers — RDMO option set providers for all searchable entity types (research fields, models, algorithms, software, hardware, methods, instruments, data sets, research problems, computational tasks, formulas, algorithmic tasks, quantities and quantity kinds).
  • :mod:~MaRDMO.search.worker — Background worker that builds and executes SPARQL queries for the three search modes (workflow, model, algorithm) and returns matching portal items.
  • :mod:~MaRDMO.search.sparql — Parameterised SPARQL query templates and filter fragments for all three search modes, assembled at runtime.

SPARQL

SPARQL query templates and filter fragments used by the MaRDMO portal search.

Each QUERY_BASE_* string is a parameterised SPARQL SELECT template that is assembled at runtime by inserting placeholder fragments (*_SPARQL). The placeholder strings bind Wikibase item/property QIDs at format-time via :meth:str.format.

Providers

RDMO optionset providers for the cross-catalog MaRDI search questionnaire.

Each provider queries the MaRDI Portal for a specific entity type and returns matching options for use in RDMO option sets. All providers require at least 3 characters, search MaRDI only, and do not offer user creation.

Workflow search providers: - :class:ResearchField — academic disciplines (also used in model search) - :class:MathematicalModel — mathematical models - :class:Algorithm — algorithms - :class:Software — software (also used in algorithm search) - :class:Hardware — computer hardware - :class:Method — methods - :class:Instrument — research tools / instruments - :class:DataSet — data sets

Model search providers: - :class:ResearchField — academic disciplines (also used in workflow search) - :class:ResearchProblem — research problems - :class:ComputationalTask — computational tasks - :class:Formula — mathematical expressions / formulas - :class:QuantityOrQuantityKind — quantities and quantity kinds

Algorithm search providers: - :class:AlgorithmicProblem — algorithmic tasks - :class:Software — software (also used in workflow search)

Algorithm

Bases: Provider

Algorithm Provider (MaRDI Portal), No User Creation, Refresh Upon Selection

Source code in MaRDMO/search/providers.py
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
class Algorithm(Provider):
    '''Algorithm Provider (MaRDI Portal),
       No User Creation, Refresh Upon Selection
    '''

    search = True

    def get_options(self, project, search=None, user=None, site=None):
        '''Query external knowledge-graph source(s) and return matching options.

        Args:
            project: RDMO project instance (unused).
            search:  Search string entered by the user; returns empty list when
                     fewer than 3 characters.
            user:    Requesting user (unused).
            site:    Current site (unused).

        Returns:
            List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
        '''
        if not search or len(search) < 3:
            return []

        return query_sources(
            search = search,
            item_class = [
                _ITEMS['algorithm']
            ],
            sources = ['mardi'],
            not_found = False
        )

get_options(project, search=None, user=None, site=None)

Query external knowledge-graph source(s) and return matching options.

Parameters:

Name Type Description Default
project

RDMO project instance (unused).

required
search

Search string entered by the user; returns empty list when fewer than 3 characters.

None
user

Requesting user (unused).

None
site

Current site (unused).

None

Returns:

Type Description

List of {"id": …, "text": …} option dicts sorted by relevance.

Source code in MaRDMO/search/providers.py
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
def get_options(self, project, search=None, user=None, site=None):
    '''Query external knowledge-graph source(s) and return matching options.

    Args:
        project: RDMO project instance (unused).
        search:  Search string entered by the user; returns empty list when
                 fewer than 3 characters.
        user:    Requesting user (unused).
        site:    Current site (unused).

    Returns:
        List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
    '''
    if not search or len(search) < 3:
        return []

    return query_sources(
        search = search,
        item_class = [
            _ITEMS['algorithm']
        ],
        sources = ['mardi'],
        not_found = False
    )

AlgorithmicProblem

Bases: Provider

Algorithmic Problem Provider (MaRDI Portal), No User Creation, Refresh Upon Selection

Source code in MaRDMO/search/providers.py
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
class AlgorithmicProblem(Provider):
    '''Algorithmic Problem Provider (MaRDI Portal),
       No User Creation, Refresh Upon Selection
    '''

    search = True

    def get_options(self, project, search=None, user=None, site=None):
        '''Query external knowledge-graph source(s) and return matching options.

        Args:
            project: RDMO project instance (unused).
            search:  Search string entered by the user; returns empty list when
                     fewer than 3 characters.
            user:    Requesting user (unused).
            site:    Current site (unused).

        Returns:
            List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
        '''
        if not search or len(search) < 3:
            return []

        return query_sources(
            search = search,
            item_class = [
                _ITEMS['algorithmic task']
            ],
            sources = ['mardi'],
            not_found = False
        )

get_options(project, search=None, user=None, site=None)

Query external knowledge-graph source(s) and return matching options.

Parameters:

Name Type Description Default
project

RDMO project instance (unused).

required
search

Search string entered by the user; returns empty list when fewer than 3 characters.

None
user

Requesting user (unused).

None
site

Current site (unused).

None

Returns:

Type Description

List of {"id": …, "text": …} option dicts sorted by relevance.

Source code in MaRDMO/search/providers.py
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
def get_options(self, project, search=None, user=None, site=None):
    '''Query external knowledge-graph source(s) and return matching options.

    Args:
        project: RDMO project instance (unused).
        search:  Search string entered by the user; returns empty list when
                 fewer than 3 characters.
        user:    Requesting user (unused).
        site:    Current site (unused).

    Returns:
        List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
    '''
    if not search or len(search) < 3:
        return []

    return query_sources(
        search = search,
        item_class = [
            _ITEMS['algorithmic task']
        ],
        sources = ['mardi'],
        not_found = False
    )

ComputationalTask

Bases: Provider

Computational Task Provider (MaRDI Portal), No User Creation, Refresh Upon Selection

Source code in MaRDMO/search/providers.py
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
class ComputationalTask(Provider):
    '''Computational Task Provider (MaRDI Portal),
       No User Creation, Refresh Upon Selection
    '''

    search = True

    def get_options(self, project, search=None, user=None, site=None):
        '''Query external knowledge-graph source(s) and return matching options.

        Args:
            project: RDMO project instance (unused).
            search:  Search string entered by the user; returns empty list when
                     fewer than 3 characters.
            user:    Requesting user (unused).
            site:    Current site (unused).

        Returns:
            List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
        '''
        if not search or len(search) < 3:
            return []

        return query_sources(
            search = search,
            item_class = [
                _ITEMS['computational task']
            ],
            sources = ['mardi'],
            not_found = False
        )

get_options(project, search=None, user=None, site=None)

Query external knowledge-graph source(s) and return matching options.

Parameters:

Name Type Description Default
project

RDMO project instance (unused).

required
search

Search string entered by the user; returns empty list when fewer than 3 characters.

None
user

Requesting user (unused).

None
site

Current site (unused).

None

Returns:

Type Description

List of {"id": …, "text": …} option dicts sorted by relevance.

Source code in MaRDMO/search/providers.py
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
def get_options(self, project, search=None, user=None, site=None):
    '''Query external knowledge-graph source(s) and return matching options.

    Args:
        project: RDMO project instance (unused).
        search:  Search string entered by the user; returns empty list when
                 fewer than 3 characters.
        user:    Requesting user (unused).
        site:    Current site (unused).

    Returns:
        List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
    '''
    if not search or len(search) < 3:
        return []

    return query_sources(
        search = search,
        item_class = [
            _ITEMS['computational task']
        ],
        sources = ['mardi'],
        not_found = False
    )

DataSet

Bases: Provider

Data Set Provider (MaRDI Portal), No User Creation, Refresh Upon Selection

Source code in MaRDMO/search/providers.py
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
class DataSet(Provider):
    '''Data Set Provider (MaRDI Portal),
       No User Creation, Refresh Upon Selection
    '''

    search = True

    def get_options(self, project, search=None, user=None, site=None):
        '''Query external knowledge-graph source(s) and return matching options.

        Args:
            project: RDMO project instance (unused).
            search:  Search string entered by the user; returns empty list when
                     fewer than 3 characters.
            user:    Requesting user (unused).
            site:    Current site (unused).

        Returns:
            List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
        '''
        if not search or len(search) < 3:
            return []

        return query_sources(
            search = search,
            item_class = [
                _ITEMS['data set']
            ],
            sources = ['mardi'],
            not_found = False
        )

get_options(project, search=None, user=None, site=None)

Query external knowledge-graph source(s) and return matching options.

Parameters:

Name Type Description Default
project

RDMO project instance (unused).

required
search

Search string entered by the user; returns empty list when fewer than 3 characters.

None
user

Requesting user (unused).

None
site

Current site (unused).

None

Returns:

Type Description

List of {"id": …, "text": …} option dicts sorted by relevance.

Source code in MaRDMO/search/providers.py
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
def get_options(self, project, search=None, user=None, site=None):
    '''Query external knowledge-graph source(s) and return matching options.

    Args:
        project: RDMO project instance (unused).
        search:  Search string entered by the user; returns empty list when
                 fewer than 3 characters.
        user:    Requesting user (unused).
        site:    Current site (unused).

    Returns:
        List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
    '''
    if not search or len(search) < 3:
        return []

    return query_sources(
        search = search,
        item_class = [
            _ITEMS['data set']
        ],
        sources = ['mardi'],
        not_found = False
    )

Formula

Bases: Provider

Formula Provider (MaRDI Portal), No User Creation, Refresh Upon Selection

Source code in MaRDMO/search/providers.py
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
class Formula(Provider):
    '''Formula Provider (MaRDI Portal),
       No User Creation, Refresh Upon Selection
    '''

    search = True

    def get_options(self, project, search=None, user=None, site=None):
        '''Query external knowledge-graph source(s) and return matching options.

        Args:
            project: RDMO project instance (unused).
            search:  Search string entered by the user; returns empty list when
                     fewer than 3 characters.
            user:    Requesting user (unused).
            site:    Current site (unused).

        Returns:
            List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
        '''
        if not search or len(search) < 3:
            return []

        return query_sources(
            search = search,
            item_class = [
                _ITEMS['formula']
            ],
            sources = ['mardi'],
            not_found = False
        )

get_options(project, search=None, user=None, site=None)

Query external knowledge-graph source(s) and return matching options.

Parameters:

Name Type Description Default
project

RDMO project instance (unused).

required
search

Search string entered by the user; returns empty list when fewer than 3 characters.

None
user

Requesting user (unused).

None
site

Current site (unused).

None

Returns:

Type Description

List of {"id": …, "text": …} option dicts sorted by relevance.

Source code in MaRDMO/search/providers.py
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
def get_options(self, project, search=None, user=None, site=None):
    '''Query external knowledge-graph source(s) and return matching options.

    Args:
        project: RDMO project instance (unused).
        search:  Search string entered by the user; returns empty list when
                 fewer than 3 characters.
        user:    Requesting user (unused).
        site:    Current site (unused).

    Returns:
        List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
    '''
    if not search or len(search) < 3:
        return []

    return query_sources(
        search = search,
        item_class = [
            _ITEMS['formula']
        ],
        sources = ['mardi'],
        not_found = False
    )

Hardware

Bases: Provider

Hardware Provider (MaRDI Portal), No User Creation, Refresh Upon Selection

Source code in MaRDMO/search/providers.py
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
class Hardware(Provider):
    '''Hardware Provider (MaRDI Portal),
       No User Creation, Refresh Upon Selection
    '''

    search = True

    def get_options(self, project, search=None, user=None, site=None):
        '''Query external knowledge-graph source(s) and return matching options.

        Args:
            project: RDMO project instance (unused).
            search:  Search string entered by the user; returns empty list when
                     fewer than 3 characters.
            user:    Requesting user (unused).
            site:    Current site (unused).

        Returns:
            List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
        '''
        if not search or len(search) < 3:
            return []

        return query_sources(
            search = search,
            item_class = [
                _ITEMS['computer hardware']
            ],
            sources = ['mardi'],
            not_found = False
        )

get_options(project, search=None, user=None, site=None)

Query external knowledge-graph source(s) and return matching options.

Parameters:

Name Type Description Default
project

RDMO project instance (unused).

required
search

Search string entered by the user; returns empty list when fewer than 3 characters.

None
user

Requesting user (unused).

None
site

Current site (unused).

None

Returns:

Type Description

List of {"id": …, "text": …} option dicts sorted by relevance.

Source code in MaRDMO/search/providers.py
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
def get_options(self, project, search=None, user=None, site=None):
    '''Query external knowledge-graph source(s) and return matching options.

    Args:
        project: RDMO project instance (unused).
        search:  Search string entered by the user; returns empty list when
                 fewer than 3 characters.
        user:    Requesting user (unused).
        site:    Current site (unused).

    Returns:
        List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
    '''
    if not search or len(search) < 3:
        return []

    return query_sources(
        search = search,
        item_class = [
            _ITEMS['computer hardware']
        ],
        sources = ['mardi'],
        not_found = False
    )

Instrument

Bases: Provider

Instrument Provider (MaRDI Portal), No User Creation, Refresh Upon Selection

Source code in MaRDMO/search/providers.py
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
class Instrument(Provider):
    '''Instrument Provider (MaRDI Portal),
       No User Creation, Refresh Upon Selection
    '''

    search = True

    def get_options(self, project, search=None, user=None, site=None):
        '''Query external knowledge-graph source(s) and return matching options.

        Args:
            project: RDMO project instance (unused).
            search:  Search string entered by the user; returns empty list when
                     fewer than 3 characters.
            user:    Requesting user (unused).
            site:    Current site (unused).

        Returns:
            List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
        '''
        if not search or len(search) < 3:
            return []

        return query_sources(
            search = search,
            item_class = [
                _ITEMS['research tool']
            ],
            sources = ['mardi'],
            not_found = False
        )

get_options(project, search=None, user=None, site=None)

Query external knowledge-graph source(s) and return matching options.

Parameters:

Name Type Description Default
project

RDMO project instance (unused).

required
search

Search string entered by the user; returns empty list when fewer than 3 characters.

None
user

Requesting user (unused).

None
site

Current site (unused).

None

Returns:

Type Description

List of {"id": …, "text": …} option dicts sorted by relevance.

Source code in MaRDMO/search/providers.py
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
def get_options(self, project, search=None, user=None, site=None):
    '''Query external knowledge-graph source(s) and return matching options.

    Args:
        project: RDMO project instance (unused).
        search:  Search string entered by the user; returns empty list when
                 fewer than 3 characters.
        user:    Requesting user (unused).
        site:    Current site (unused).

    Returns:
        List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
    '''
    if not search or len(search) < 3:
        return []

    return query_sources(
        search = search,
        item_class = [
            _ITEMS['research tool']
        ],
        sources = ['mardi'],
        not_found = False
    )

MathematicalModel

Bases: Provider

Mathematical Model Provider (MaRDI Portal), No User Creation, Refresh Upon Selection

Source code in MaRDMO/search/providers.py
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
class MathematicalModel(Provider):
    '''Mathematical Model Provider (MaRDI Portal),
       No User Creation, Refresh Upon Selection
    '''

    search = True

    def get_options(self, project, search=None, user=None, site=None):
        '''Query external knowledge-graph source(s) and return matching options.

        Args:
            project: RDMO project instance (unused).
            search:  Search string entered by the user; returns empty list when
                     fewer than 3 characters.
            user:    Requesting user (unused).
            site:    Current site (unused).

        Returns:
            List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
        '''
        if not search or len(search) < 3:
            return []

        return query_sources(
            search = search,
            item_class = [
                _ITEMS['mathematical model']
            ],
            sources = ['mardi'],
            not_found = False
        )

get_options(project, search=None, user=None, site=None)

Query external knowledge-graph source(s) and return matching options.

Parameters:

Name Type Description Default
project

RDMO project instance (unused).

required
search

Search string entered by the user; returns empty list when fewer than 3 characters.

None
user

Requesting user (unused).

None
site

Current site (unused).

None

Returns:

Type Description

List of {"id": …, "text": …} option dicts sorted by relevance.

Source code in MaRDMO/search/providers.py
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
def get_options(self, project, search=None, user=None, site=None):
    '''Query external knowledge-graph source(s) and return matching options.

    Args:
        project: RDMO project instance (unused).
        search:  Search string entered by the user; returns empty list when
                 fewer than 3 characters.
        user:    Requesting user (unused).
        site:    Current site (unused).

    Returns:
        List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
    '''
    if not search or len(search) < 3:
        return []

    return query_sources(
        search = search,
        item_class = [
            _ITEMS['mathematical model']
        ],
        sources = ['mardi'],
        not_found = False
    )

Method

Bases: Provider

Method Provider (MaRDI Portal), No User Creation, Refresh Upon Selection

Source code in MaRDMO/search/providers.py
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
class Method(Provider):
    '''Method Provider (MaRDI Portal),
       No User Creation, Refresh Upon Selection
    '''

    search = True

    def get_options(self, project, search=None, user=None, site=None):
        '''Query external knowledge-graph source(s) and return matching options.

        Args:
            project: RDMO project instance (unused).
            search:  Search string entered by the user; returns empty list when
                     fewer than 3 characters.
            user:    Requesting user (unused).
            site:    Current site (unused).

        Returns:
            List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
        '''
        if not search or len(search) < 3:
            return []

        return query_sources(
            search = search,
            item_class = [
                _ITEMS['method']
            ],
            sources = ['mardi'],
            not_found = False
        )

get_options(project, search=None, user=None, site=None)

Query external knowledge-graph source(s) and return matching options.

Parameters:

Name Type Description Default
project

RDMO project instance (unused).

required
search

Search string entered by the user; returns empty list when fewer than 3 characters.

None
user

Requesting user (unused).

None
site

Current site (unused).

None

Returns:

Type Description

List of {"id": …, "text": …} option dicts sorted by relevance.

Source code in MaRDMO/search/providers.py
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
def get_options(self, project, search=None, user=None, site=None):
    '''Query external knowledge-graph source(s) and return matching options.

    Args:
        project: RDMO project instance (unused).
        search:  Search string entered by the user; returns empty list when
                 fewer than 3 characters.
        user:    Requesting user (unused).
        site:    Current site (unused).

    Returns:
        List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
    '''
    if not search or len(search) < 3:
        return []

    return query_sources(
        search = search,
        item_class = [
            _ITEMS['method']
        ],
        sources = ['mardi'],
        not_found = False
    )

QuantityOrQuantityKind

Bases: Provider

Quantity / Quantity Kind Provider (MaRDI Portal), No User Creation, Refresh Upon Selection

Source code in MaRDMO/search/providers.py
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
class QuantityOrQuantityKind(Provider):
    '''Quantity / Quantity Kind Provider (MaRDI Portal),
       No User Creation, Refresh Upon Selection
    '''

    search = True

    def get_options(self, project, search=None, user=None, site=None):
        '''Query external knowledge-graph source(s) and return matching options.

        Args:
            project: RDMO project instance (unused).
            search:  Search string entered by the user; returns empty list when
                     fewer than 3 characters.
            user:    Requesting user (unused).
            site:    Current site (unused).

        Returns:
            List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
        '''
        if not search or len(search) < 3:
            return []

        return query_sources(
            search = search,
            item_class = [
                _ITEMS['quantity'],
                _ITEMS['kind of quantity'],
            ],
            sources = ['mardi'],
            not_found = False
        )

get_options(project, search=None, user=None, site=None)

Query external knowledge-graph source(s) and return matching options.

Parameters:

Name Type Description Default
project

RDMO project instance (unused).

required
search

Search string entered by the user; returns empty list when fewer than 3 characters.

None
user

Requesting user (unused).

None
site

Current site (unused).

None

Returns:

Type Description

List of {"id": …, "text": …} option dicts sorted by relevance.

Source code in MaRDMO/search/providers.py
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
def get_options(self, project, search=None, user=None, site=None):
    '''Query external knowledge-graph source(s) and return matching options.

    Args:
        project: RDMO project instance (unused).
        search:  Search string entered by the user; returns empty list when
                 fewer than 3 characters.
        user:    Requesting user (unused).
        site:    Current site (unused).

    Returns:
        List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
    '''
    if not search or len(search) < 3:
        return []

    return query_sources(
        search = search,
        item_class = [
            _ITEMS['quantity'],
            _ITEMS['kind of quantity'],
        ],
        sources = ['mardi'],
        not_found = False
    )

ResearchField

Bases: Provider

Research Field Provider (MaRDI Portal / Wikidata), No User Creation, Refresh Upon Selection

Source code in MaRDMO/search/providers.py
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
class ResearchField(Provider):
    '''Research Field Provider (MaRDI Portal / Wikidata),
       No User Creation, Refresh Upon Selection
    '''

    search = True

    def get_options(self, project, search=None, user=None, site=None):
        '''Query external knowledge-graph source(s) and return matching options.

        Args:
            project: RDMO project instance (used for user-entry lookups when applicable).
            search:  Search string entered by the user; returns empty list when
                     fewer than 3 characters.
            user:    Requesting user (unused).
            site:    Current site (unused).

        Returns:
            List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
        '''
        if not search or len(search) < 3:
            return []

        return query_sources(
            search = search,
            item_class = [
                _ITEMS['academic discipline']
            ],
            sources = ['mardi'],
            not_found = False
        )

get_options(project, search=None, user=None, site=None)

Query external knowledge-graph source(s) and return matching options.

Parameters:

Name Type Description Default
project

RDMO project instance (used for user-entry lookups when applicable).

required
search

Search string entered by the user; returns empty list when fewer than 3 characters.

None
user

Requesting user (unused).

None
site

Current site (unused).

None

Returns:

Type Description

List of {"id": …, "text": …} option dicts sorted by relevance.

Source code in MaRDMO/search/providers.py
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
def get_options(self, project, search=None, user=None, site=None):
    '''Query external knowledge-graph source(s) and return matching options.

    Args:
        project: RDMO project instance (used for user-entry lookups when applicable).
        search:  Search string entered by the user; returns empty list when
                 fewer than 3 characters.
        user:    Requesting user (unused).
        site:    Current site (unused).

    Returns:
        List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
    '''
    if not search or len(search) < 3:
        return []

    return query_sources(
        search = search,
        item_class = [
            _ITEMS['academic discipline']
        ],
        sources = ['mardi'],
        not_found = False
    )

ResearchProblem

Bases: Provider

Research Problem Provider (MaRDI Portal), No User Creation, Refresh Upon Selection

Source code in MaRDMO/search/providers.py
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
class ResearchProblem(Provider):
    '''Research Problem Provider (MaRDI Portal),
       No User Creation, Refresh Upon Selection
    '''

    search = True

    def get_options(self, project, search=None, user=None, site=None):
        '''Query external knowledge-graph source(s) and return matching options.

        Args:
            project: RDMO project instance (unused).
            search:  Search string entered by the user; returns empty list when
                     fewer than 3 characters.
            user:    Requesting user (unused).
            site:    Current site (unused).

        Returns:
            List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
        '''
        if not search or len(search) < 3:
            return []

        return query_sources(
            search = search,
            item_class = [
                _ITEMS['research problem']
            ],
            sources = ['mardi'],
            not_found = False
        )

get_options(project, search=None, user=None, site=None)

Query external knowledge-graph source(s) and return matching options.

Parameters:

Name Type Description Default
project

RDMO project instance (unused).

required
search

Search string entered by the user; returns empty list when fewer than 3 characters.

None
user

Requesting user (unused).

None
site

Current site (unused).

None

Returns:

Type Description

List of {"id": …, "text": …} option dicts sorted by relevance.

Source code in MaRDMO/search/providers.py
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
def get_options(self, project, search=None, user=None, site=None):
    '''Query external knowledge-graph source(s) and return matching options.

    Args:
        project: RDMO project instance (unused).
        search:  Search string entered by the user; returns empty list when
                 fewer than 3 characters.
        user:    Requesting user (unused).
        site:    Current site (unused).

    Returns:
        List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
    '''
    if not search or len(search) < 3:
        return []

    return query_sources(
        search = search,
        item_class = [
            _ITEMS['research problem']
        ],
        sources = ['mardi'],
        not_found = False
    )

Software

Bases: Provider

Software Provider (MaRDI Portal), No User Creation, Refresh Upon Selection

Source code in MaRDMO/search/providers.py
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
class Software(Provider):
    '''Software Provider (MaRDI Portal),
       No User Creation, Refresh Upon Selection
    '''

    search = True

    def get_options(self, project, search=None, user=None, site=None):
        '''Query external knowledge-graph source(s) and return matching options.

        Args:
            project: RDMO project instance (unused).
            search:  Search string entered by the user; returns empty list when
                     fewer than 3 characters.
            user:    Requesting user (unused).
            site:    Current site (unused).

        Returns:
            List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
        '''
        if not search or len(search) < 3:
            return []

        return query_sources(
            search = search,
            item_class = [
                _ITEMS['software']
            ],
            sources = ['mardi'],
            not_found = False
        )

get_options(project, search=None, user=None, site=None)

Query external knowledge-graph source(s) and return matching options.

Parameters:

Name Type Description Default
project

RDMO project instance (unused).

required
search

Search string entered by the user; returns empty list when fewer than 3 characters.

None
user

Requesting user (unused).

None
site

Current site (unused).

None

Returns:

Type Description

List of {"id": …, "text": …} option dicts sorted by relevance.

Source code in MaRDMO/search/providers.py
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
def get_options(self, project, search=None, user=None, site=None):
    '''Query external knowledge-graph source(s) and return matching options.

    Args:
        project: RDMO project instance (unused).
        search:  Search string entered by the user; returns empty list when
                 fewer than 3 characters.
        user:    Requesting user (unused).
        site:    Current site (unused).

    Returns:
        List of ``{"id": …, "text": …}`` option dicts sorted by relevance.
    '''
    if not search or len(search) < 3:
        return []

    return query_sources(
        search = search,
        item_class = [
            _ITEMS['software']
        ],
        sources = ['mardi'],
        not_found = False
    )

Workers

Background worker for the cross-catalog MaRDI search questionnaire.

Dispatches on the selected search mode and builds a SPARQL query from the user-supplied filter criteria, executes it against the MaRDI Portal, and stores the results for the view layer to render.

Three search modes are supported:

  • InterdisciplinaryWorkflow — filters: research objective, academic discipline, mathematical model, algorithm, software, hardware, method, instrument, data set.
  • MathematicalModel — filters: model properties, research problem, academic discipline, computational task, formula, quantity.
  • Algorithm — filters: algorithmic task, software.

Provides:

  • search — entry point called by the view layer; mutates answers in place with "query", "no_results", and "links" keys.

search(answers, options)

Build SPARQL queries from user search criteria, execute them, and store results.

Dispatches on answers["search"]["options"] to one of three search modes: Interdisciplinary Workflow, Mathematical Model, or Algorithm. For each mode, constructs a SPARQL query from the selected filter criteria, executes it against the appropriate endpoint (MaRDI Portal or MathAlgoDB), and writes the escaped query string, result count, and link list back into answers.

Parameters:

Name Type Description Default
answers

Top-level answers dict (mutated in place with "query", "no_results", and "links" keys).

required
options

Global RDMO options dict used for option-value comparisons.

required

Returns:

Type Description

The mutated answers dict.

Source code in MaRDMO/search/worker.py
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
def search(answers, options):
    '''Build SPARQL queries from user search criteria, execute them, and store results.

    Dispatches on ``answers["search"]["options"]`` to one of three search
    modes: Interdisciplinary Workflow, Mathematical Model, or Algorithm.
    For each mode, constructs a SPARQL query from the selected filter criteria,
    executes it against the appropriate endpoint (MaRDI Portal or MathAlgoDB),
    and writes the escaped query string, result count, and link list back into
    *answers*.

    Args:
        answers: Top-level answers dict (mutated in place with ``"query"``,
                 ``"no_results"``, and ``"links"`` keys).
        options: Global RDMO options dict used for option-value comparisons.

    Returns:
        The mutated *answers* dict.
    '''
    if answers['search'].get('options') == options['InterdisciplinaryWorkflow']:

        s = answers['search']
        items = get_items()
        props = get_properties()

        filter_keys = [
            'research-objective', 'academic-discipline', 'mathematical-model',
            'algorithm', 'software', 'hardware', 'method', 'instrument', 'data-set',
        ]
        if not any(s.get(k) for k in filter_keys):
            answers['query'] = 'Workflow search requested but no parameters defined.'
            answers['no_results'] = '0'
            answers['links'] = []
            return answers

        parts = []

        for idx, keyword in enumerate(s.get('research-objective', {}).values()):
            if keyword:
                parts.append(
                    f"  # research objective: {keyword}\n"
                    + WF_RESEARCH_OBJ_SPARQL.format(
                        idx=idx, keyword=keyword.lower(), **items, **props
                    )
                )

        for idx, item in enumerate(s.get('academic-discipline', {}).values()):
            qid = item['ID'].split(':')[1]
            parts.append(
                f"  # academic discipline: {item['Name']}\n"
                + WF_DISCIPLINE_SPARQL.format(idx=idx, qid=qid, **items, **props)
            )

        for idx, item in enumerate(s.get('mathematical-model', {}).values()):
            qid = item['ID'].split(':')[1]
            parts.append(
                f"  # mathematical model: {item['Name']}\n"
                + WF_MODEL_SPARQL.format(idx=idx, qid=qid, **items, **props)
            )

        for idx, item in enumerate(s.get('algorithm', {}).values()):
            qid = item['ID'].split(':')[1]
            parts.append(
                f"  # algorithm: {item['Name']}\n"
                + WF_ALGORITHM_SPARQL.format(idx=idx, qid=qid, **items, **props)
            )

        for idx, item in enumerate(s.get('software', {}).values()):
            qid = item['ID'].split(':')[1]
            parts.append(
                f"  # software: {item['Name']}\n"
                + WF_SOFTWARE_SPARQL.format(idx=idx, qid=qid, **items, **props)
            )

        for idx, item in enumerate(s.get('hardware', {}).values()):
            qid = item['ID'].split(':')[1]
            parts.append(
                f"  # hardware: {item['Name']}\n"
                + WF_HARDWARE_SPARQL.format(idx=idx, qid=qid, **items, **props)
            )

        for idx, item in enumerate(s.get('method', {}).values()):
            qid = item['ID'].split(':')[1]
            parts.append(
                f"  # method: {item['Name']}\n"
                + WF_METHOD_SPARQL.format(idx=idx, qid=qid, **items, **props)
            )

        for idx, item in enumerate(s.get('instrument', {}).values()):
            qid = item['ID'].split(':')[1]
            parts.append(
                f"  # instrument: {item['Name']}\n"
                + WF_INSTRUMENT_SPARQL.format(idx=idx, qid=qid, **items, **props)
            )

        for idx, item in enumerate(s.get('data-set', {}).values()):
            qid = item['ID'].split(':')[1]
            parts.append(
                f"  # data set: {item['Name']}\n"
                + WF_DATASET_SPARQL.format(idx=idx, qid=qid, **items, **props)
            )

        query = "\n".join(
            line
            for line in QUERY_BASE_WORKFLOW_SEARCH.format(
                "\n".join(parts),
                **items,
                **props,
            ).splitlines()
            if line.strip()
        )

        answers['query'] = html.escape(query).replace('\n', '<br>')

        results = query_sparql(query, get_url('mardi', 'sparql'))
        answers['no_results'] = str(len(results))

        links = []
        for result in results:
            links.append([
                result["label"]["value"],
                f"{get_item_url('mardi')}{result['qid']['value']}",
            ])
        answers['links'] = links

    elif answers['search'].get('options') == options['MathematicalModel']:

        s = answers['search']
        items = get_items()
        props = get_properties()

        filter_keys = [
            'mathematical-model-properties', 'research-problem',
            'academic-discipline', 'computational-task', 'formula', 'quantity',
        ]
        if not any(s.get(k) for k in filter_keys):
            answers['query'] = 'Model search requested but no parameters defined.'
            answers['no_results'] = '0'
            answers['links'] = []
            return answers

        parts = []

        for option_uri in s.get('mathematical-model-properties', {}).values():
            uri_tail = option_uri.rsplit('/', 1)[-1]
            item_key = MM_PROPERTY_TO_ITEM.get(uri_tail)
            if item_key:
                label = uri_tail.replace('-', ' ')
                parts.append(
                    f"  # model property: {label}\n"
                    + MM_PROPERTY_SPARQL.format(
                        qid=items[item_key], **items, **props
                    )
                )

        for idx, item in enumerate(s.get('research-problem', {}).values()):
            qid = item['ID'].split(':')[1]
            parts.append(
                f"  # research problem: {item['Name']}\n"
                + MM_PROBLEM_SPARQL.format(idx=idx, qid=qid, **items, **props)
            )

        for idx, item in enumerate(s.get('academic-discipline', {}).values()):
            qid = item['ID'].split(':')[1]
            parts.append(
                f"  # academic discipline: {item['Name']}\n"
                + MM_DISCIPLINE_SPARQL.format(idx=idx, qid=qid, **items, **props)
            )

        for idx, item in enumerate(s.get('computational-task', {}).values()):
            qid = item['ID'].split(':')[1]
            parts.append(
                f"  # computational task: {item['Name']}\n"
                + MM_TASK_SPARQL.format(idx=idx, qid=qid, **items, **props)
            )

        for idx, item in enumerate(s.get('formula', {}).values()):
            qid = item['ID'].split(':')[1]
            parts.append(
                f"  # formula: {item['Name']}\n"
                + MM_FORMULA_SPARQL.format(idx=idx, qid=qid, **items, **props)
            )

        for idx, item in enumerate(s.get('quantity', {}).values()):
            qid = item['ID'].split(':')[1]
            parts.append(
                f"  # quantity: {item['Name']}\n"
                + MM_QUANTITY_SPARQL.format(idx=idx, qid=qid, **items, **props)
            )

        query = "\n".join(
            line
            for line in QUERY_BASE_MODEL_SEARCH.format(
                "\n".join(parts),
                **items,
                **props,
            ).splitlines()
            if line.strip()
        )

        answers['query'] = html.escape(query).replace('\n', '<br>')

        results = query_sparql(query, get_url('mardi', 'sparql'))
        answers['no_results'] = str(len(results))

        links = []
        for result in results:
            links.append([
                result["label"]["value"],
                f"{get_item_url('mardi')}{result['qid']['value']}",
            ])
        answers['links'] = links

    elif answers['search'].get('options') == options['Algorithm']:

        s = answers['search']
        items = get_items()
        props = get_properties()

        filter_keys = ['algorithmic-task', 'software']
        if not any(s.get(k) for k in filter_keys):
            answers['query'] = (
                'Algorithm search requested but no parameters defined.'
            )
            answers['no_results'] = '0'
            answers['links'] = []
            return answers

        parts = []

        for idx, item in enumerate(s.get('algorithmic-task', {}).values()):
            qid = item['ID'].split(':')[1]
            parts.append(
                f"  # algorithmic task: {item['Name']}\n"
                + ALG_TASK_SPARQL.format(idx=idx, qid=qid, **items, **props)
            )

        for idx, item in enumerate(s.get('software', {}).values()):
            qid = item['ID'].split(':')[1]
            parts.append(
                f"  # software: {item['Name']}\n"
                + ALG_SOFTWARE_SPARQL.format(idx=idx, qid=qid, **items, **props)
            )

        query = "\n".join(
            line
            for line in QUERY_BASE_ALGORITHM_SEARCH.format(
                "\n".join(parts),
                **items,
                **props,
            ).splitlines()
            if line.strip()
        )

        answers['query'] = html.escape(query).replace('\n', '<br>')

        results = query_sparql(query, get_url('mardi', 'sparql'))
        answers['no_results'] = str(len(results))

        links = []
        for result in results:
            links.append([
                result["label"]["value"],
                f"{get_item_url('mardi')}{result['qid']['value']}",
            ])
        answers['links'] = links

    return answers