MINERVA v22.0
Manual

Back to the admin manual

Configuration file - structure and definitions#

MINERVA projects can have a complex structure (read about project structure here) and the accompanying configuration file (always named config.json) allows to integrate them, and pre-define configuration options that will become available on project file (.zip) upload.

The configuration file has the following structure:

Available defined licenses#

See also https://minerva-service.lcsb.uni.lu/minerva/new_api/licenses/.

An example configuration file#

Below is a complete JSON structure for an example project. A short summary:

{
    "maps": [
        {
            "custom_elements": [
                {
                    "element_id": "sa11",
                    "immediate_link": null,
                    "glyph_file_name": "glyphs/g1.png",
                    "submap": null
                },
                {
                    "element_id": "ca1",
                    "immediate_link": null,
                    "glyph_file_name": "glyphs/g2.png",
                    "submap": null
                },
                {
                    "element_id": "sa13",
                    "immediate_link": null,
                    "glyph_file_name": null,
                    "submap": "submap_example"
                }
            ],
            "default_center_x": 10.0,
            "default_center_y": 10.0,
            "default_zoom_level": 1,
            "max_zoom_levels": 2,
            "name": "advanced_map_example"
        },
        {
            "custom_elements": [],
            "default_center_x": 100.0,
            "default_center_y": 100.0,
            "default_zoom_level": 2,
            "max_zoom_levels": 2,
            "name": "submap_example"
        }
    ],
    "overview_images": [
        {
            "links": [
                {
                    "link_type": "SEARCH_QUERY",
                    "polygon": [
                        {
                            "x": 967.0,
                            "y": 700.0
                        },
                        {
                            "x": 2067.0,
                            "y": 700.0
                        },
                        {
                            "x": 2067.0,
                            "y": 1207.0
                        },
                        {
                            "x": 967.0,
                            "y": 1207.0
                        }
                    ],
                    "target_map_filename": null,
                    "target_map_x": null,
                    "target_map_y": null,
                    "target_map_z": null,
                    "target_overview_image_filename": null,
                    "search_query": "reaction:re3,reaction:re4"
                }
            ],
            "filename": "overview_sub.png",
            "width": 3033,
            "height": 1685
        },
        {
            "links": [
                {
                    "link_type": "OVERVIEW_IMAGE",
                    "polygon": [
                        {
                            "x": 167.0,
                            "y": 607.0
                        },
                        {
                            "x": 1267.0,
                            "y": 607.0
                        },
                        {
                            "x": 1267.0,
                            "y": 1117.0
                        },
                        {
                            "x": 167.0,
                            "y": 1117.0
                        }
                    ],
                    "target_map_filename": null,
                    "target_map_x": null,
                    "target_map_y": null,
                    "target_map_z": null,
                    "target_overview_image_filename": "overview_sub.png",
                    "search_query": null
                },
                {
                    "link_type": "MAP",
                    "polygon": [
                        {
                            "x": 1653.0,
                            "y": 453.0
                        },
                        {
                            "x": 2277.0,
                            "y": 191.0
                        },
                        {
                            "x": 2901.0,
                            "y": 453.0
                        },
                        {
                            "x": 2901.0,
                            "y": 1500.0
                        },
                        {
                            "x": 2277.0,
                            "y": 1177.0
                        },
                        {
                            "x": 1653.0,
                            "y": 1500.0
                        }
                    ],
                    "target_map_filename": "advanced_map_example",
                    "target_map_x": 270.0,
                    "target_map_y": 24.0,
                    "target_map_z": 4.0,
                    "target_overview_image_filename": null,
                    "search_query": null
                }
            ],
            "filename": "overview_main.png",
            "width": 3033,
            "height": 1685
        }
    ],
    "sbgn": false,
    "network_view_as_default": false,
    "hide_on_zoom": true,
    "disease": "https://identifiers.org/mesh:D010300",
    "organism": "https://identifiers.org/taxonomy:9606",
    "name": "advanced_map",
    "version": "v0.1",
    "notify_email": "my@email.com",
    "custom_license_name": "",
    "custom_license_url": "",
    "source_git_repository": null,
    "source_git_branch": null,
    "license": {
        "name": "Creative Commons Attribution 4.0 International Public License",
        "content": "[text of the license from https://creativecommons.org/licenses/by/4.0/deed.en]"
    }
}