Skip to content

Commit

Permalink
fixing references, removing duplicates between the short and long ver…
Browse files Browse the repository at this point in the history
…sion of the basic workshop.
  • Loading branch information
KathleenLabrie committed Aug 13, 2021
1 parent f7e356e commit 4a45730
Show file tree
Hide file tree
Showing 11 changed files with 53 additions and 53 deletions.
10 changes: 5 additions & 5 deletions Workshops/BasicDRAGONS-1hr/sphinx/caldb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

.. before we are too tired, let's tackle this one.
.. _caldb:
.. _basic1_caldb:

*************************
Local calibration manager
Expand Down Expand Up @@ -101,7 +101,7 @@ that you will not wipe the database accidentally. **The** ``init`` **is require
only once.** If you already have the database created, maybe even populated,
you can switch back to it simply by ensuring ``database_dir`` points to it.

.. _ex_caldb1:
.. _basic1_ex_caldb1:

.. admonition:: Exercise - Caldb 1

Expand All @@ -111,7 +111,7 @@ you can switch back to it simply by ensuring ``database_dir`` points to it.
Confirm with ``ls`` that a new ``cal_manager.db`` has been created. You
can also use ``caldb config`` to confirm that the new database is active.

[:ref:`Solution <solution_caldb1>`]
[:ref:`Solution <basic1_solution_caldb1>`]


Usage
Expand Down Expand Up @@ -141,7 +141,7 @@ And finally, to delete information about one file from the database::
``remove`` will only remove the entry in the database, it will not remove
the file on disk.

.. _ex_caldb2:
.. _basic1_ex_caldb2:

.. admonition:: Exercise - Caldb 2

Expand All @@ -154,5 +154,5 @@ the file on disk.
for the demo) and list its content. Both the dark and the flat should
now be listed.

[:ref:`Solution <solution_caldb2>`]
[:ref:`Solution <basic1_solution_caldb2>`]

6 changes: 3 additions & 3 deletions Workshops/BasicDRAGONS-1hr/sphinx/customize_recipes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.. include:: DRAGONSlinks.txt

.. _customize_recipes:
.. _basic1_customize_recipes:

*****************
Customize Recipes
Expand Down Expand Up @@ -94,7 +94,7 @@ name of our recipe library (``myNIRIrecipes``) and the name of the recipe
The new intermediate outputs have the suffixes ``_flatCorrected`` and
``_skySubtracted``.

.. _ex_customrecipe1:
.. _basic1_ex_customrecipe1:

.. admonition:: Exercise - Custom Recipe 1

Expand All @@ -104,5 +104,5 @@ The new intermediate outputs have the suffixes ``_flatCorrected`` and
Hint: ``cat flats.lis`` to get the name of a flat to use with ``showrecipes``
to get the location and name of the NIRI flat recipe library.

[:ref:`Solution <solution_customrecipe1>`]
[:ref:`Solution <basic1_solution_customrecipe1>`]

4 changes: 2 additions & 2 deletions Workshops/BasicDRAGONS-1hr/sphinx/demo_imaging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.. include:: DRAGONSlinks.txt

.. _demo_imaging:
.. _basic1_demo_imaging:

************
Demo imaging
Expand Down Expand Up @@ -101,7 +101,7 @@ Create the master dark and add it to the calibration manager.
The ``@`` character before the name of the input file is the "at-file" syntax.
We will look into this later.

.. _demo_flat:
.. _basic1_demo_flat:

**Flat**

Expand Down
2 changes: 1 addition & 1 deletion Workshops/BasicDRAGONS-1hr/sphinx/explore_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.. include:: DRAGONSlinks.txt

.. _explore_data:
.. _basic1_explore_data:


************
Expand Down
2 changes: 1 addition & 1 deletion Workshops/BasicDRAGONS-1hr/sphinx/objectives.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. objectives.rst
.. _objectives:
.. _basic1_objectives:

*******************
Learning Objectives
Expand Down
16 changes: 8 additions & 8 deletions Workshops/BasicDRAGONS-1hr/sphinx/reduce.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.. include:: DRAGONSlinks.txt

.. _reduce:
.. _basic1_reduce:

****************
Using ``reduce``
Expand Down Expand Up @@ -50,7 +50,7 @@ The syntax to change the value of an input parameter is as follow::

reduce file.fits -p primitive:parameter=value

.. _ex_reduce1:
.. _basic1_ex_reduce1:

.. admonition:: Exercise - "reduce" 1

Expand All @@ -61,9 +61,9 @@ The syntax to change the value of an input parameter is as follow::

Hint #1: ``cat flats.lis`` to get the name of a flat to use with ``showpars``.

Hint #2: See the :ref:`command used in the demo <demo_flat>`
Hint #2: See the :ref:`command used in the demo <basic1_demo_flat>`

[:ref:`Solution <solution_reduce1>`]
[:ref:`Solution <basic1_solution_reduce1>`]

.. reduce @flats.lis -p normalizeFlat:scale=mean --suffix _exercise2
Expand Down Expand Up @@ -112,7 +112,7 @@ Another use of the ``-r`` option is to run personal recipes rather than the
ones distributed with DRAGONS. We will show how that is done in the next
chapter.

.. _ex_reduce2:
.. _basic1_ex_reduce2:

.. admonition:: Exercise - "reduce" 2

Expand All @@ -123,7 +123,7 @@ chapter.
the target fills the field-of-view of the science frames, the sky flat
here will not be usable, but it's okay, we are just playing while learning.

[:ref:`Solution <solution_reduce2>`]
[:ref:`Solution <basic1_solution_reduce2>`]

.. reduce @target.lis -r makeSkyFlat --suffix _skyflat
Expand All @@ -142,7 +142,7 @@ Allowed values for "<cal>": dark, bias, flat, arc, standard. Eg::

reduce @mylist.lis --user_cal processed_arc:my_special_arc.fits

.. _ex_reduce3:
.. _basic1_ex_reduce3:

.. admonition:: Exercise - "reduce" 3

Expand All @@ -155,7 +155,7 @@ Allowed values for "<cal>": dark, bias, flat, arc, standard. Eg::
Modify this command to allow the dark correction with the dark we used
for the science frame, ``N20160102S0423_dark.fits``.

[:ref:`Solution <solution_reduce3>`]
[:ref:`Solution <basic1_solution_reduce3>`]

.. reduce reduce @stdstar.lis -p addDQ:user_bpm=N20160102S0373_bpm.fits
--user_cal processed_dark:N20160102S0423_dark.fits
2 changes: 1 addition & 1 deletion Workshops/BasicDRAGONS-1hr/sphinx/resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<a href="https://dragons.readthedocs.io/projects/recipe-system-users-manual/en/stable/index.html" target="_blank">Recipe System User Manual</a>

.. _resources:
.. _basic1_resources:

*********
Resources
Expand Down
50 changes: 25 additions & 25 deletions Workshops/BasicDRAGONS-1hr/sphinx/solutions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.. include:: DRAGONSlinks.txt

.. _solutions:
.. _basic1_solutions:

**********************
Solutions to exercises
Expand All @@ -11,10 +11,10 @@ Solutions to exercises
Solutions to the Local calibration manager exercises
====================================================

.. _solution_caldb1:
.. _basic1_solution_caldb1:

Solution to :ref:`Exercise - Caldb 1 <ex_caldb1>`
-------------------------------------------------
Solution to :ref:`Exercise - Caldb 1 <basic1_ex_caldb1>`
--------------------------------------------------------
The ``rsys.cfg`` file should look like this::

[calibs]
Expand All @@ -36,10 +36,10 @@ The ``rsys.cfg`` file should look like this::
The 'standalone' flag is active, meaning that local calibrations will be used


.. _solution_caldb2:
.. _basic1_solution_caldb2:

Solution to :ref:`Exercise - Caldb 2 <ex_caldb2>`
-------------------------------------------------
Solution to :ref:`Exercise - Caldb 2 <basic1_ex_caldb2>`
--------------------------------------------------------
It is important do to successfully complete :ref:`Exercise - Caldb 1 <ex_caldb1>`
before attempting Exercise 2.

Expand Down Expand Up @@ -97,29 +97,29 @@ Confirm activation with ``caldb config``.
Solutions to the ``reduce`` exercises
=====================================

.. _solution_reduce1:
.. _basic1_solution_reduce1:

Solution to :ref:`Exercise - "reduce" 1 <ex_reduce1>`
-----------------------------------------------------
Solution to :ref:`Exercise - "reduce" 1 <basic1_ex_reduce1>`
------------------------------------------------------------

::

reduce @flats.lis -p normalizeFlat:scale=mean --suffix _exercise1

.. _solution_reduce2:
.. _basic1_solution_reduce2:

Solution to :ref:`Exercise - "reduce" 2 <ex_reduce2>`
-----------------------------------------------------
Solution to :ref:`Exercise - "reduce" 2 <basic1_ex_reduce2>`
------------------------------------------------------------

::

reduce @target.lis -r makeSkyFlat --suffix _skyflat


.. _solution_reduce3:
.. _basic1_solution_reduce3:

Solution to :ref:`Exercise - "reduce" 3 <ex_reduce3>`
-----------------------------------------------------
Solution to :ref:`Exercise - "reduce" 3 <basic1_ex_reduce3>`
------------------------------------------------------------

While it is not recommended to use a processed dark of the wrong exposure,
here is how you would force DRAGONS to use the science's master dark
Expand All @@ -133,10 +133,10 @@ on the flux standard from the demo.
Solutions to the Customize recipes exercise
===========================================

.. _solution_customrecipe1:
.. _basic1_solution_customrecipe1:

Solution to :ref:`Exercise - Custom Recipe 1 <ex_customrecipe1>`
----------------------------------------------------------------
Solution to :ref:`Exercise - Custom Recipe 1 <basic1_ex_customrecipe1>`
-----------------------------------------------------------------------

::

Expand Down Expand Up @@ -174,10 +174,10 @@ Solution to :ref:`Exercise - Custom Recipe 1 <ex_customrecipe1>`
Solutions to the Tools exercise
===========================================

.. _solution_tools1:
.. _basic1_solution_tools1:

Solution to :ref:`Exercise - Tools 1 <ex_tools1>`
-------------------------------------------------
Solution to :ref:`Exercise - Tools 1 <basic1_ex_tools1>`
--------------------------------------------------------

::

Expand Down Expand Up @@ -243,10 +243,10 @@ Solution to :ref:`Exercise - Tools 1 <ex_tools1>`
../playdata/N20160103S0472.fits 1.001 blank 2016-01-03


.. _solution_tools2:
.. _basic1_solution_tools2:

Solution to :ref:`Exercise - Tools 2 <ex_tools2>`
-------------------------------------------------
Solution to :ref:`Exercise - Tools 2 <basic1_ex_tools2>`
--------------------------------------------------------

::

Expand Down
10 changes: 5 additions & 5 deletions Workshops/BasicDRAGONS-1hr/sphinx/tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@



.. _tools:
.. _basic1_tools:



Expand Down Expand Up @@ -120,15 +120,15 @@ The syntax is::
The default is to print on the terminal. A comma-separate list can be
produced with the ``--csv`` flag.

.. _ex_tools1:
.. _basic1_ex_tools1:

.. admonition:: Exercise - Tools 1

Get the exposure time, filter name, and UT date of all the
observations in ``playdata``. Use the |descriptors| list from the
|astrodatauser|.

[:ref:`Solution <solution_tools1>`]
[:ref:`Solution <basic1_solution_tools1>`]

.. showd -d exposure_time,filter_name,ut_date ../playdata/*.fits
Expand Down Expand Up @@ -199,7 +199,7 @@ the internal quotes used around strings.

Finally, the expression can use the ``and`` and ``or`` logical operators.

.. _ex_tools2:
.. _basic1_ex_tools2:

.. admonition:: Exercise - Tools 2

Expand All @@ -211,7 +211,7 @@ Finally, the expression can use the ``and`` and ``or`` logical operators.

Descriptors: ``observation_type``, ``observation_class``, ``object``.

[:ref:`Solution <solution_tools2>`]
[:ref:`Solution <basic1_solution_tools2>`]

.. dataselect ../playdata/*.fits --expr='observation_class=="science" and observation_type=="OBJECT"' | showd -d object
.. dataselect ../playdata/*.fits --expr='observation_class=="partnerCal" and observation_type=="OBJECT"' | showd -d object
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.. include:: DRAGONSlinks.txt

.. _recipes_and_primitives:
.. _basic1_recipes_and_primitives:

**************************************************
What are Recipes, Recipe Libraries, and Primitives
Expand Down
2 changes: 1 addition & 1 deletion Workshops/BasicDRAGONS-1hr/sphinx/what_is_dragons.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. what_is_dragons.rst
.. _what_is_dragons:
.. _basic1_what_is_dragons:

***************
What is DRAGONS
Expand Down

0 comments on commit 4a45730

Please sign in to comment.