Skip to content
This repository was archived by the owner on Sep 8, 2025. It is now read-only.

Project folder structure

Thomas Halwax edited this page Mar 23, 2020 · 12 revisions

In ODIN we use plain filesystem folders and files to hold all data required - no databases or other services are required.

A project folder contains all user-generated data and settings in order to display the common operational picture.

ODIN stores its user-generated data within the user's HOME directory. We use a subdirectory structure ODIN/projects where the projects will be stored.

Whenever a user creates a new project or imports one a new subfolder will be created. The name of the subfolder is a UUID. This allows

  • to rename projects.
  • duplicate projects names.
  • minimizing the probability of collisions when importing projects from other users.

Default content of a project folder

All data, settings etc. are JSON files. So we make these both user and machine readable.

metadata.json

The metadata file contains user-related content like the project name.

preferences.json

We try to make things as simple as possible. In order to save not only the data generated but also user defined settings ODIN persists those using the file preferences.

preview.jpeg (optional)

ODIN creates screenshots of the current project that will show up on ODIN's project management page. So the user can easily choose which project to open.

Layers (folder)

Layers are files containing GeoJSON data with additional properties. ODIN uses these properties in order to apply additional styling to the GeoJSON features. ODIN treats all *.json files within the layers folder to be a layer.

Clone this wiki locally