Skip to content

Commit

Permalink
Switching READMEs (back) to rst
Browse files Browse the repository at this point in the history
  • Loading branch information
drphilmarshall committed Aug 8, 2018
1 parent f1fe37f commit bff7066
Show file tree
Hide file tree
Showing 9 changed files with 151 additions and 19 deletions.
25 changes: 25 additions & 0 deletions 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 <DataInventory.ipynb>`_,
`rendered <https://nbviewer.jupyter.org/github/LSSTScienceCollaborations/StackClub/blob/rendered/Basics/DataInventory.nbconvert.ipynb>`_

.. 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 <https://github.com/LSSTScienceCollaborations/StackClub/issues/new?body=@drphilmarshall>`_
7 changes: 0 additions & 7 deletions Calibration/README.md

This file was deleted.

25 changes: 25 additions & 0 deletions 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 <XXXX.ipynb>`_,
`rendered <https://nbviewer.jupyter.org/github/LSSTScienceCollaborations/StackClub/blob/rendered/Calibration/XXXX.nbconvert.ipynb>`_

.. 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 <https://github.com/LSSTScienceCollaborations/StackClub/issues/new?body=@TBD>`_
7 changes: 0 additions & 7 deletions Docker/README.md

This file was deleted.

25 changes: 25 additions & 0 deletions 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 <XXXX.ipynb>`_,
`rendered <https://nbviewer.jupyter.org/github/LSSTScienceCollaborations/StackClub/blob/rendered/Docker/XXXX.nbconvert.ipynb>`_

.. 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 <https://github.com/LSSTScienceCollaborations/StackClub/issues/new?body=@TBD>`_
25 changes: 25 additions & 0 deletions GettingStarted/templates/template_README.rst
@@ -0,0 +1,25 @@
FOLDER_NAME
===========

This folder contains a set of tutorial notebooks exploring <FOLDER_TOPICS>. 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 <XXXX.ipynb>`_,
`rendered <https://nbviewer.jupyter.org/github/LSSTScienceCollaborations/StackClub/blob/rendered/FOLDER_NAME/XXXX.nbconvert.ipynb>`_

.. 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 <https://github.com/LSSTScienceCollaborations/StackClub/issues/new?body=@TBD>`_
5 changes: 0 additions & 5 deletions ImageProcessing/README.md

This file was deleted.

26 changes: 26 additions & 0 deletions 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 <ProcessEimage.ipynb>`_,
`rendered <https://nbviewer.jupyter.org/github/LSSTScienceCollaborations/StackClub/blob/rendered/ImageProcessing/ProcessEimage.nbconvert.ipynb>`_

.. 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 <https://github.com/LSSTScienceCollaborations/StackClub/issues/new?body=@kadrlica>`_

25 changes: 25 additions & 0 deletions 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 <XXXX.ipynb>`_,
`rendered <https://nbviewer.jupyter.org/github/LSSTScienceCollaborations/StackClub/blob/rendered/Validation/XXXX.nbconvert.ipynb>`_

.. 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 <https://github.com/LSSTScienceCollaborations/StackClub/issues/new?body=@TBD>`_

0 comments on commit bff7066

Please sign in to comment.