mdmodels 0.2.10

A tool to generate models, code and schemas from markdown files
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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
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

{##### Macros ####}

{# Get the type of an attribute #}
{%- macro get_dtype(attribute) %}
{%- for dtype in attribute.dtypes %}
    {%- set dtype_string -%}
    `{{ wrap_multiple(wrap_multiple(dtype, attribute.multiple)) }}`
    {%- endset -%}
    {{ linkify(dtype, dtype_string) }}
{%- endfor %}
{%- endmacro %}

{# Wrap a multiple in a list statement if it is the case #}
{%- macro wrap_multiple(dtype, multiple) -%}

{%- if multiple is true -%}
list[{{ dtype }}]
{%- else -%}
{{ dtype }}
{%- endif -%}

{%- endmacro -%}

{# Turn in-document types into links #}
{%- macro linkify(dtype, dtype_string) %}

{%- if dtype in object_names or dtype in enum_names -%}
[{{ dtype_string }}](#{{ dtype | lower }})
{%- else -%}
{{ dtype_string }}
{%- endif -%}

{%- endmacro %}
{#################}

{%- if not config.nav %}
---
hide:
    - navigation
---
{% endif %}

{%- if title %}
# {{ title }}
{%- else -%}
# Model Reference
{%- endif %}

This page provides comprehensive information about the structure and components of the data model, including detailed descriptions of the types and their properties, information on enumerations, and an overview of the ontologies used and their associated prefixes. Below, you will find a graph that visually represents the overall structure of the data model.

??? quote "Graph"
    ``` mermaid
    flowchart TB
    {%- for object in object_names %}
        {{ object | lower}}({{ object }})
    {%- endfor %}
    {%- for enum in enum_names %}
        {{ enum | lower}}({{ enum }})
    {%- endfor %}
    {%- for object in objects %}
    {%- for attribute in object.attributes %}
    {%- for dtype in attribute.dtypes %}
    {%- if dtype in object_names or dtype in enum_names %}
        {{ object.name | lower}}({{ object.name }}) --> {{ dtype | lower }}({{ dtype }})
    {%- endif %}
    {%- endfor %}
    {%- endfor %}
    {%- endfor %}
    {% for object in object_names %}
        click {{ object | lower }} "#{{ object | lower }}" "Go to {{ object }}"
    {%- endfor %}
    {%- for enum in enum_names %}
        click {{ enum | lower }} "#{{ enum | lower }}" "Go to {{ enum }}"
    {%- endfor %}
    ```

{% if prefixes | length > 0 %}
## Ontologies

{%- for prefix, value in prefixes %}
- [{{ prefix }}]({{ value }})
{%- endfor %}
{% endif %}

## Types

{% for object in objects  %}
### {{ object.name }}
{{ object.docstring }}
{%- for attribute in object.attributes %}
{%- set required %}
{%- if attribute.required %}*{% endif %}
{%- endset %}

__{{ attribute.name }}__{{ required }} {{ get_dtype(attribute) }}
{% if attribute.docstring %}
- {{ attribute.docstring }}
{%- endif  %}
{% if 'default' in attribute %}
- `Default`: {{ attribute.default }}
{%- endif  %}
{%- for option in attribute.options -%}
- `{{ option.key | capitalize }}`: {{ option.value }}
{%- endfor %}
{%- endfor %}

{% if not loop.last %}------{%- endif %}
{% endfor %}
{%- if enums | length > 0 %}
## Enumerations
{% endif %}

{%- for enum in enums %}
### {{ enum.name }}
{% if enum.docstring %}
{{ enum.docstring }}
{% endif %}
| Alias | Value |
|-------|-------|
{%- for key, value in enum.mappings | dictsort %}
| `{{ key }}` | {{ value }} |
{%- endfor %}
{% endfor %}