ANN-RADAR / ann-radar-prototype

ANN RADAR is a decision support tool for identifying urban testbed locations
MIT License
3 stars 1 forks source link

kurze Doku wo welche Files liegen bitte #339

Closed annikabock closed 1 year ago

plumdumpling commented 1 year ago

Konfigurationen

Alle Konfigurationsdateien liegen im ann-radar-data Bucket im Google Cloud Storage.

Layer Konfiguration

In der Datei layers_config.json können Layer und ihre die Legenden konfiguriert werden. Die Konfiguration folgt dabei folgendem Schema:

{
  // Layername bitte bei Entwicklern erfragen
  "layerName": {
    // Der Name des Attributs, welches zur Anzeige des Layers benutzt wird (optional, nur bei Layern die eigene Daten anzeigen benötigt)
    "attributeName": "XYZ",
    // Liste von Legendenpunkten
    "classification": [
      // Legendenpunkt einzelner Wert: 1 rot (#FF0000)
      {
        "from": 1,
        "to": 1,
        "color": "#FF0000"
      },
      // Legendenpunkt Spanne: 2 – 10 orange (#FFCC00)
      {
        "from": 2,
        "to": 10,
        "color": "#FFCC00"
      },
      // Legendenpunkt Spanne mit Abstufungen: 11 – 19 grün (#00FF00) mit drei Abstufungen (ausklappbar)
      {
        "from": 11,
        "to": 19,
        "color": "#00FF00",
        "classification": [
          {
            "from": 11,
            "to": 13,
            "color": "#00FF004d"
          },
          {
            "from": 14,
            "to": 16,
            "color": "#00FF0099"
          },
          {
            "from": 17,
            "to": 19,
            "color": "#00FF00FF"
          }
        ]
      },
      // Legendenpunkt: "20 Minuten" blau (#0000FF)
      {
        "from": 20,
        "to": 20,
        "unit": "minutes", // Bei dem `unit`-Wert handelt es sich um einen Translation Key. Dieser muss in den Übersetzungen angelegt werden.
        "color": "#0000FF"
      }
    ]
  }
}

Sustainability Domains Konfiguration

Die Datei potential_config.json beinhaltet Informationen über die Attribute der Potentialtabellen (Solar, Energie Effizienz und Mobility). Für jede Tabelle können die initial sichtbaren Attribute (Spalten) konfiguriert werden. Außerdem werden hier die Übersetzungen der Attributsnamen (Deutsch und Englisch) gepflegt.

{
  "table": {
    "columns": {
      "selected": {
        // Liste der initial sichtbaren Attribute für die Energie-Effizienz-Tabelle
        "energyEfficiency": ["AnzFlur", "mittlFlur", "BGF", ...],
        // Liste der initial sichtbaren Attribute für die Mobility-Tabelle
        "mobility": [...],
        // Liste der initial sichtbaren Attribute für die Solar-Tabelle
        "solar": [...]
      },
      // Übersetzungen der Attribute
      "translations": {
        "Attributsname": {
          "en": "English Translation of the attribute name",
          "de": "Deutsche Übersetzung des Attributsnamens"
        },
        ...
      }
    }
  }
}

Balanced Scorecards Konfiguration

Die Konfigurationsdateien für die Balanced Scorecards heißen wie folgt:

Die Konfigurationsdateien bestehen aus einer Liste an Objekten. Es können beliebig viele Objekte und darin beliebig viele measures (bestehend aus id und description) hinterlegt werden. Das objective der Objekte ist optional.

Beispiel:

[
  {
    "objective": "Objective A",
    "measures": [
      {
        "id": "A1",
        "description": "Measure A1"
      },
      {
        "id": "A2",
        "description": "Measure A2"
      }
    ]
  },
  {
    "measures": [
      {
        "id": "B1",
        "description": "Measure B1"
      },
      {
        "id": "B2",
        "description": "Measure B2"
      }
    ]
  }
]

⚠️ Wichtig! Die Measure IDs müssen einzigartig sein und dürfen im Nachhinein nicht mehr verändert werden, damit eine Zuordnung der eingetragenen Daten möglich ist.

Daten

Layerdaten

Die Daten folgender Layer liegen ebenfalls im ann-radar-data Bucket im Google Cloud Storage:

Alle anderen Layer werden von https://geodienste.hamburg.de bezogen.

Eigene Daten

Die von Frank Rogge aufbereiteten Daten der verschiedenen Administrationsebenen (Baublöcke, Statistische Gebiete, Stadtteil, Bezirk und Stadt) sind im Google Cloud Storage Bucket unter folgenden Namen als JSON-Dateien abgelegt:

Übersetzungen

Die Übersetzungsdateien sind Teil der Codebasis und werden im Ordner /src/i18n als JSON-Dateien abgelegt.

annikabock commented 1 year ago

@imsk111 schau mal hier

plumdumpling commented 1 year ago

Kurzer Nachtrag:

Secrets

Targomo

Targomo Region und Service Key sind als Secrets im Google Cloud Secrets Manager hinterlegt.