Detail L1

source/_static/custom.css

@@ -11,3 +11,10 @@ html[data-theme="light"] {
 html[data-theme="dark"] {
     --pst-color-primary: #8800ff;
 }
+
+
+/* Ensure the SVG diagrams scale with font size, not diagram width */
+img[src$=".svg"] {
+    max-width: 100%;
+    height: auto;
+}

source/conf.py

@@ -35,6 +35,8 @@
 # ones.
 extensions = [
     "sphinxcontrib.plantuml",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.todo",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -70,11 +72,8 @@
         version_match = "v" + release
 
 html_theme_options = {
-    # "logo_link": "",
     "github_url": "https://github.com/vodf/vodf-docs",
     "icon_links_label": "Quick Links",
-    # "show_nav_level": 4,
-    # "navigation_depth": 4,
     "use_edit_page_button": True,
     "navbar_align": "content",
     "navbar_end": ["version-switcher", "navbar-icon-links"],  # "theme-switcher"
@@ -84,9 +83,16 @@
     },
     "header_links_before_dropdown": 6,
     "announcement": "<p>This is an unreleased version, informaton may not be correct</p>",
-    "footer_start": ["copyright",],
+    "footer_start": [
+        "copyright",
+    ],
     "footer_center": ["last-updated"],
     "footer_end": ["sphinx-version", "theme-version"],
+    "logo": {
+        "alt_text":"VODF: Very-High-Energy Open Data Format",
+        "image_light": "source/_static/VODF-logo.png",
+        "image_dark": "source/_static/VODF-logo.png",
+    },
 }
 
 html_context = {
@@ -101,14 +107,15 @@
 html_css_files = [
     "custom.css",
 ]
-html_logo = "_static/VODF-logo.svg"
 
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
 
+# Show TODO entries. Disable this before release
+todo_include_todos = True
 
 # ======================================================================
 # Options for LaTeX docment output

source/specification/common.inc

@@ -0,0 +1,43 @@
+@startuml
+hide circles
+hide methods
+skinparam DefaultFontSize 14
+skinparam DefaultFontName "Arial"
+
+
+
+<style>
+package {
+        LineColor #gray
+        FontColor #gray
+}
+
+class {
+
+        backgroundColor white-aliceblue
+        header {
+                fontColor #ffffff
+                backgroundColor #8800ff
+                fontStyle bold
+        }
+
+}
+
+
+.extern {
+        class {
+                header {
+                        backgroundColor #gray
+                }
+        }
+
+}
+
+</style>
+
+skinparam classStereotypeFontColor white
+
+hide <<extern>> stereotype
+
+
+@enduml

source/specification/core-concepts.rst

@@ -3,3 +3,47 @@ Core Concepts
 
 This describes the overall data model of VODF and how its  component parts are
 inter-related.
+
+Data Levels
+-----------
+
+.. todo::
+
+   Describe high-level relationship between L1 to L4
+
+Common Types
+------------
+
+.. uml::
+
+   !include common.inc
+   class TimeStamp
+
+Maps and N-Dimensional Arrays
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+
+
+PDGID
+~~~~~
+
+.. uml::
+
+   !include common.inc
+   class PDGID <<integer>>
+
+
+Particle ids used in VODF shall follow the integer `https://particle.wiki/wiki/PDG_particle_numbering_scheme <Particle Data Group Numbering Scheme>`_, e.g.:
+
+
+.. csv-table:: Some example PDGIDs
+   :header: "Particle","ID"
+   :widths: 1,5
+
+   ":math:`\gamma`", 22
+   ":math:`e-`", 11
+   ":math:`p`", 2212
+   ":math:`\nu_e`", 12
+   ":math:`\nu_\mu`", 14
+   ":math:`\nu_\tau`",16

source/specification/level-1/coverage.plantuml

@@ -0,0 +1,46 @@
+@startuml
+!include ../common.inc
+skinparam linetype ortho
+
+package IVOA <<cloud>> {
+
+        class SMOC
+        class TMOC
+        class STMOC
+}
+
+package VODF {
+        package L1 {
+                class SpatialCoverage {
+                        + r_fov : float
+                        ..optional..
+                        + region : Region
+                }
+
+                class TemporalCoverage {
+                        + t_start
+                        + t_stop
+                }
+
+                class SpectralCoverage {
+                        + energy_min
+                        + energy_max
+                }
+
+                Coverage *-- SpatialCoverage
+                Coverage *-- TemporalCoverage
+                Coverage *-- SpectralCoverage
+                TemporalCoverage *-d--- "0..1" IVOA.TMOC
+                TemporalCoverage *-d--- "0..1" IVOA.STMOC
+                SpatialCoverage *-d--- "0..1" IVOA.SMOC
+                SpatialCoverage *-d--- "0..1" IVOA.STMOC
+
+
+                class OnTime <<extern>>
+                class Pointing <<extern>>
+                TemporalCoverage ..> OnTime
+                TemporalCoverage ..> Pointing
+        }
+}
+
+@enduml

source/specification/level-1/eventlist.plantuml

@@ -0,0 +1,38 @@
+@startuml
+!include ../common.inc
+
+
+package VODF.L1 {
+
+        class EventList {
+                + collection_id
+                + obs_id
+        }
+        class Event {
+                + event_id: int64
+                --
+                + ra_reco: float32
+                + dec_reco: float32
+                + time_reco: TimeStamp
+                + energy_reco: float32
+                ..optional..
+                + event_type: int
+                + alt_reco: float32
+                + az_reco: float32
+        }
+
+        class SimulatedEvent {
+                + alt_true: float32
+                + az_true: float32
+                + energy_true: float32
+                + time_true: TimeStamp
+                + particle_id_true : PDGID
+                ..optional..
+                + ra_true: float32
+                + dec_true: float32
+        }
+
+        EventList "1" o-- "0..*" Event
+        Event -r-|> SimulatedEvent
+}
+@enduml