add vac skeleton

desihub · May 8, 2023 · 5afc99e · 5afc99e
1 parent 5f8bf17
commit 5afc99e
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 0 deletions.
diff --git a/doc/DESI_ROOT/index.rst b/doc/DESI_ROOT/index.rst
@@ -12,3 +12,4 @@ Subdirectories:
    :maxdepth: 1
 
    survey/index
+   vac/index
diff --git a/doc/DESI_ROOT/vac/RELEASE/index.rst b/doc/DESI_ROOT/vac/RELEASE/index.rst
@@ -0,0 +1,15 @@
+=======
+RELEASE
+=======
+
+``${DESI_ROOT}/vac/RELEASE`` contains the Value Added Catalogs (VAC) associated with a
+particular data release. The value of ``RELEASE`` will typically be ``edr``, ``dr1``, and so on.
+
+Within this directory, each VAC will have a unique name.
+
+Subdirectories:
+
+.. toctree::
+   :maxdepth: 1
+
+   lss/index
diff --git a/doc/DESI_ROOT/vac/RELEASE/lss/index.rst b/doc/DESI_ROOT/vac/RELEASE/lss/index.rst
@@ -0,0 +1,6 @@
+===
+lss
+===
+
+This file is a placeholder for the index.rst file in the root of the lss data model.
+Please overwrite!
diff --git a/doc/DESI_ROOT/vac/index.rst b/doc/DESI_ROOT/vac/index.rst
@@ -0,0 +1,13 @@
+===
+vac
+===
+
+``${DESI_ROOT}/vac`` contains Value Added Catalogs (VAC). These are typically associated 
+with a specific ``RELEASE`` such as Early Data Release (EDR).
+
+Subdirectories:
+
+.. toctree::
+   :maxdepth: 1
+
+   RELEASE/index