Add schema browser

lsst · Sep 29, 2021 · 19cbc82 · 19cbc82
1 parent ffc3fff
commit 19cbc82
Show file tree

Hide file tree

Showing 10 changed files with 239 additions and 23 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,23 +1,3 @@
-.sconsign.dblite
-config.log
-.sconf_temp
-*.o
-*.os
-*.so
-*.cfgc
-*.pyc
-*_wrap.cc
-*Lib.py
-_build.*
-doc/html
-doc/xml
-doc/*.tag
-doc/*.inc
-doc/doxygen.conf
-sql/lsstSchema4mysqlS12_lsstsim.sql
-sql/lsstSchema4mysqlS12_sdss.sql
-tests/.tests
-tests/.cache
-version.py
-bin/measureTable.py
-bin/schema_to_metadata.py
+_site
+Gemfile
+Gemfile.lock
diff --git a/_config.yml b/_config.yml
@@ -0,0 +1,9 @@
+theme: jekyll-theme-cayman
+data_dir: ./yml
+layouts_dir: ./browser/_layouts
+exclude:
+  - Gemfile
+  - /tap-schema
+  - /yml
+readme_index:
+  remove_originals: true
diff --git a/browser/_layouts/schema.html b/browser/_layouts/schema.html
@@ -0,0 +1,64 @@
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: "en-US" }}">
+  <head>
+    <meta charset="UTF-8">
+
+{% seo %}
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="theme-color" content="#157878">
+    <link rel="stylesheet" href="{{ '/assets/css/style2.css?v=' | append: site.github.build_revision | relative_url }}">
+  </head>
+  <body>
+    <div id="container">
+      <nav id="sidebar">
+        <img id="logo" src="{{ '/browser/assets/images/rubinobs.png' | relative_url }}"/>
+        <ul>
+          <li><a href=".">Schema Browser</a></li>
+          <ul>
+            <li><a href="">{{ page.title }}</a></li>
+            <ul>
+              {%- for table in site.data[page.schema].tables %}
+              <li><a href="{{ table['@id'] }}">{{ table['@id'] | remove:'#' }}</a></li>
+              {%- endfor %}
+            </ul>
+          </ul>
+        </ul>
+      </nav><!--
+   --><div id="content">
+        <main class="main-content">
+          <h1>{{ page.title }}</h1>
+          {{ content }}
+          {%- for table in site.data[page.schema].tables %}
+          <section id="{{ table['@id'] | remove:'#' }}">
+            <h2>{{ table.name }}</h2>
+            <p>{{ table.description }}</p>
+            <table class="schema-table">
+              <tr>
+                <th>Column Name</th>
+                <th>Data Type</th>
+                <th>Unit</th>
+                <th>Description [UCD]</th>
+              </tr>
+              {%- for col in table.columns %}
+              <tr id="{{ col['@id'] | remove:'#' }}">
+                <td class="column-name">{{ col.name }}</td>
+                <td>{{ col.datatype }}</td>
+                <td>{{ col['fits:tunit'] }}</td>
+                <td>
+                    {{- col.description | escape }}
+                    {%- if col['ivoa:ucd'] %} [{{col['ivoa:ucd']}}]{% endif -%}
+                </td>
+              </tr>
+              {%- endfor %}
+            </table>
+          </section>
+          {%- endfor %}
+          <footer class="site-footer">
+            <span class="site-footer-owner"><a href="{{ site.github.repository_url }}">{{ site.github.repository_name }}</a> is maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a>.</span>
+            <span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages</a>.</span>
+          </footer>
+        </main>
+      </div>
+    </div>
+</body>
+</html>
diff --git a/browser/_layouts/schema_index.html b/browser/_layouts/schema_index.html
@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: "en-US" }}">
+  <head>
+    <meta charset="UTF-8">
+
+{% seo %}
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="theme-color" content="#157878">
+    <link rel="stylesheet" href="{{ '/assets/css/style2.css?v=' | append: site.github.build_revision | relative_url }}">
+  </head>
+  <body>
+    <div id="container">
+      <nav id="sidebar">
+        <img id="logo" src="{{ '/browser/assets/images/rubinobs.png' | relative_url }}"/>
+        <ul>
+          <li><a href=".">Schema Browser</a></li>
+          <ul>
+            {%- assign schemas = site.pages | where: 'dir','/browser/' | sort: 'sort-index' %}
+            {%- for schema in schemas %}
+            {%- if schema.name != 'index.md' %}
+            <li><a href="{{ schema.url | relative_url }}">{{ schema.title }}</a></li>
+            {%- endif %}
+            {%- endfor %}
+          </ul>
+        </ul>
+      </nav><!--
+   --><div id="content">
+        <main class="main-content">
+          <h1>{{ page.title }}</h1>
+          {{ content }}
+          <footer class="site-footer">
+            <span class="site-footer-owner"><a href="{{ site.github.repository_url }}">{{ site.github.repository_name }}</a> is maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a>.</span>
+            <span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages</a>.</span>
+          </footer>
+        </main>
+      </div>
+    </div>
+</body>
+</html>
diff --git a/browser/assets/css/style2.scss b/browser/assets/css/style2.scss
@@ -0,0 +1,78 @@
+---
+permalink: /assets/css/style2.css
+---
+
+@import 'jekyll-theme-cayman';
+
+html {
+	height: 100%;
+}
+
+body {
+	margin: 0;
+	height: 100%;
+}
+
+a {
+	color: #058b8c
+}
+
+#container {
+	height: 100%;
+}
+
+#sidebar {
+	display: inline-block;
+	vertical-align: top;
+	height: 100%;
+	width: 20%;
+	overflow: auto;
+	padding-left: 1rem;
+}
+
+#sidebar #logo {
+	width: 80%;
+	display: block;
+	margin-left: auto;
+	margin-right: auto;
+}
+
+#sidebar ul {
+	list-style-type: none;
+	margin-left: 1rem;
+	padding: 0;  
+}
+
+#sidebar ul ul ul {
+	font-size: .90rem;
+}
+
+#content {
+	display: inline-block;
+	vertical-align: top;
+	height: 100%;
+	width: 80%;
+	overflow: auto;
+}
+
+.main-content {
+	max-width: inherit;
+	margin: inherit;
+	padding: 0rem 2rem 2rem 2rem;
+}
+
+.main-content > :first-child {
+	margin-top: 1rem;
+}
+
+.main-content section > :first-child {
+	margin-top: 2rem;
+}
+
+.main-content h1, .main-content h2, .main-content h3, .main-content h4, .main-content h5, .main-content h6 {
+	color: #058B8C
+}
+
+.main-content .schema-table .column-name {
+	font-family: monospace;	
+}
diff --git a/browser/assets/images/rubinobs.png b/browser/assets/images/rubinobs.png
diff --git a/browser/baseline.md b/browser/baseline.md
@@ -0,0 +1,9 @@
+---
+layout: schema
+title: LSST Baseline Schema
+schema: baselineSchema
+sort-index: 30
+---
+The LSST Baseline Schema describes the "goal" of the Rubin Observatory construction project; it is the
+column-for-column physical description that corresponds to the abstract schema specified by the _Data Products
+Definition Document_ ([LSE-163](https://lse-163.lsst.io)) and from which document _LSST Database Baseline Schema_ ([LDM-153](https://ldm-153.lsst.io)) is produced.
diff --git a/browser/dp01.md b/browser/dp01.md
@@ -0,0 +1,7 @@
+---
+layout: schema
+title: Data Preview 0.1 Schema
+schema: dp01_dc2
+sort-index: 10
+---
+Data Preview 0.1 includes five tables based on the DESC's Data Challenge 2 simulation of 300 square degrees of the wide-fast-deep LSST survey region after 5 years. All tables contain objects detected in coadded images.
diff --git a/browser/hsc.md b/browser/hsc.md
@@ -0,0 +1,11 @@
+---
+layout: schema
+title: HSC Schema
+schema: hsc
+sort-index: 20
+---
+The HSC Schema describes the outputs of the latest data release production pipelines. This schema is intended
+to approximate the LSST Baseline Schema, but with the changes necessary to reflect the current state of the
+pipelines (e.g., columns that are not yet computed by the pipelines are removed, some names differ, and some
+additional useful columns are added). This schema is used by [ci_hsc](https://github.com/lsst/ci_hsc), which
+verifies the schema of the pipeline output files. 
diff --git a/browser/index.md b/browser/index.md
@@ -0,0 +1,19 @@
+---
+layout: schema_index
+title: Science Data Model Schemas
+---
+This schema browser provides a view on a curated subset of the Rubin Observatory's database schemas for
+user-facing data products (the Science Data Model, or SDM).  These pages are rendered directly from the latest
+revisions of schema definition YAML files maintained in the [sdm_schemas](https://github.com/lsst/sdm_schemas)
+github repository.
+
+Schemas available here for browsing include:
+
+<ul>
+    {%- assign schemas = site.pages | where: 'dir','/browser/' | sort: 'sort-index' %}
+    {%- for schema in schemas %}
+    {%- if schema.name != 'index.md' %}
+    <li><a href="{{ schema.url | relative_url }}">{{ schema.title }}</a> {{ schema.content }}</li>
+    {%- endif %}
+    {%- endfor %}
+</ul>