diff --git a/Basics/README.rst b/Basics/README.rst new file mode 100644 index 00000000..e16e174c --- /dev/null +++ b/Basics/README.rst @@ -0,0 +1,25 @@ +Basics +====== + +This folder contains a set of tutorial notebooks exploring the basic properties of the DM Stack data structures, classes and functions. See the index table below for links to the notebook code, and an auto-rendered view of the notebook with outputs. + + +.. list-table:: + :widths: 10 20 10 10 + :header-rows: 1 + + * - Notebook + - Short description + - Links + - Owner + + + * - **Data Inventory** + - Explore the available datasets in the LSST Science Platform shared folders. + - `ipynb `_, + `rendered `_ + + .. image:: https://github.com/LSSTScienceCollaborations/StackClub/blob/rendered/Basics/log/DataInventory.svg + :target: https://github.com/LSSTScienceCollaborations/StackClub/blob/rendered/Basics/log/DataInventory.log + + - `Phil Marshall `_ diff --git a/Calibration/README.md b/Calibration/README.md deleted file mode 100644 index 4520cdba..00000000 --- a/Calibration/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Calibration - -This folder contains a set of tutorial notebooks exploring the calibration routines in the LSST science pipelines. - -| Notebook | Description | Owner | -|---|---|---| -| [None so far]() | Not yet started. | TBD (@tbd) | diff --git a/Calibration/README.rst b/Calibration/README.rst new file mode 100644 index 00000000..bde4c62d --- /dev/null +++ b/Calibration/README.rst @@ -0,0 +1,25 @@ +Calibration +=========== + +This folder contains a set of tutorial notebooks exploring the calibration routines in the LSST science pipelines. See the index table below for links to the notebook code, and an auto-rendered view of the notebook with outputs. + + +.. list-table:: + :widths: 10 20 10 10 + :header-rows: 1 + + * - Notebook + - Short description + - Links + - Owner + + + * - **None so far** + - Not yet started. + - `ipynb `_, + `rendered `_ + + .. image:: https://github.com/LSSTScienceCollaborations/StackClub/blob/rendered/Calibration/log/XXXX.svg + :target: https://github.com/LSSTScienceCollaborations/StackClub/blob/rendered/Calibration/log/XXXX.log + + - `TBD `_ diff --git a/Docker/README.md b/Docker/README.md deleted file mode 100644 index 114eeb3e..00000000 --- a/Docker/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Docker - -This folder contains a set of tutorial notebooks exploring the use of Docker in installing and running the DM Stack. - -| Notebook | Description | Owner | -|---|---|---| -| [None so far]() | Not yet started. | TBD (@tbd) | diff --git a/Docker/README.rst b/Docker/README.rst new file mode 100644 index 00000000..f15be775 --- /dev/null +++ b/Docker/README.rst @@ -0,0 +1,25 @@ +Docker +====== + +This folder contains a set of tutorial notebooks exploring the use of Docker in installing and running the DM Stack. See the index table below for links to the notebook code, and an auto-rendered view of the notebook with outputs. + + +.. list-table:: + :widths: 10 20 10 10 + :header-rows: 1 + + * - Notebook + - Short description + - Links + - Owner + + + * - **None so far** + - Not yet started. + - `ipynb `_, + `rendered `_ + + .. image:: https://github.com/LSSTScienceCollaborations/StackClub/blob/rendered/Docker/log/XXXX.svg + :target: https://github.com/LSSTScienceCollaborations/StackClub/blob/rendered/Docker/log/XXXX.log + + - `TBD `_ diff --git a/GettingStarted/templates/template_README.rst b/GettingStarted/templates/template_README.rst new file mode 100644 index 00000000..0505e241 --- /dev/null +++ b/GettingStarted/templates/template_README.rst @@ -0,0 +1,25 @@ +FOLDER_NAME +=========== + +This folder contains a set of tutorial notebooks exploring . See the index table below for links to the notebook code, and an auto-rendered view of the notebook with outputs. + + +.. list-table:: + :widths: 10 20 10 10 + :header-rows: 1 + + * - Notebook + - Short description + - Links + - Owner + + + * - **None so far** + - Not yet started. + - `ipynb `_, + `rendered `_ + + .. image:: https://github.com/LSSTScienceCollaborations/StackClub/blob/rendered/FOLDER_NAME/log/XXXX.svg + :target: https://github.com/LSSTScienceCollaborations/StackClub/blob/rendered/FOLDER_NAME/log/XXXX.log + + - `TBD `_ diff --git a/ImageProcessing/README.md b/ImageProcessing/README.md deleted file mode 100644 index 0d31c246..00000000 --- a/ImageProcessing/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Image Processing - -This folder contains: - -* [ProcessEimage.ipynb](ProcessEimage.ipynb), which shows how to process an "e-image" using the DM Stack. \ No newline at end of file diff --git a/ImageProcessing/README.rst b/ImageProcessing/README.rst new file mode 100644 index 00000000..36bdd516 --- /dev/null +++ b/ImageProcessing/README.rst @@ -0,0 +1,26 @@ +Image Processing +================ + +This folder contains a set of tutorial notebooks exploring the image processing routines in the LSST science pipelines. See the index table below for links to the notebook code, and an auto-rendered view of the notebook with outputs. + + +.. list-table:: + :widths: 10 20 10 10 + :header-rows: 1 + + * - Notebook + - Short description + - Links + - Owner + + + * - **ProcessEimage.ipynb** + - How to process a simulated "e-image" using the DM Stack. + - `ipynb `_, + `rendered `_ + + .. image:: https://github.com/LSSTScienceCollaborations/StackClub/blob/rendered/ImageProcessing/log/ProcessEimage.svg + :target: https://github.com/LSSTScienceCollaborations/StackClub/blob/rendered/ImageProcessing/log/ProcessEimage.log + + - `Alex Drlica-Wagner `_ + diff --git a/Validation/README.rst b/Validation/README.rst new file mode 100644 index 00000000..f5ae0e1e --- /dev/null +++ b/Validation/README.rst @@ -0,0 +1,25 @@ +Validation +========== + +This folder contains a set of tutorial notebooks exploring the validation packages accompanying the DM Stack. See the index table below for links to the notebook code, and an auto-rendered view of the notebook with outputs. + + +.. list-table:: + :widths: 10 20 10 10 + :header-rows: 1 + + * - Notebook + - Short description + - Links + - Owner + + + * - **None so far** + - Not yet started. + - `ipynb `_, + `rendered `_ + + .. image:: https://github.com/LSSTScienceCollaborations/StackClub/blob/rendered/Validation/log/XXXX.svg + :target: https://github.com/LSSTScienceCollaborations/StackClub/blob/rendered/Validation/log/XXXX.log + + - `TBD `_