Add WFC3 notebook 'wfc3_image_displayer_analyzer.ipynb' (spacetelesco…

…pe#105)

* updated _toc.yml and _config.yml files

* added trailing spaces to display_image.py, row_column_stats.py

* updated notebook-level requirements.txt file.

* wfc3_image_displayer_analyzer.ipynb: cleared notebook outputs.

* Update display_image.py

edits for PEP8 compliance and removing `ginga.util` dependence

* Update row_column_stats.py

changes for PEP8 compliance

* Update row_column_stats.py

last missing PEP8 changes

* Update requirements.txt

removing version pins and adding jupyter

* Update wfc3_image_displayer_analyzer.ipynb

changes for PEP8 compliance and some minor formatting

* Update README.md

changes for new information about creating a virtual environment

* Update wfc3_image_displayer_analyzer.ipynb

missed some PEP8 stuff; hopefully the last commit 🫠

---------

Co-authored-by: bjkuhn <[email protected]>

_config.yml

@@ -53,7 +53,6 @@ exclude_patterns: [notebooks/DrizzlePac/align_mosaics/align_mosaics.ipynb,
                    notebooks/WFC3/dash/dash.ipynb,
                    notebooks/WFC3/filter_transformations/filter_transformations.ipynb,
                    notebooks/WFC3/flux_conversion_tool/flux_conversion_tool.ipynb,
-                   notebooks/WFC3/image_displayer_analyzer/wfc3_image_displayer_analyzer.ipynb,
                    notebooks/WFC3/ir_ima_visualization/IR_IMA_Visualization_with_an_Example_of_Time_Variable_Background.ipynb,
                    notebooks/WFC3/ir_scattered_light_calwf3_corrections/Correcting_for_Scattered_Light_in_IR_Exposures_Using_calwf3_to_Mask_Bad_Reads.ipynb,
                    notebooks/WFC3/ir_scattered_light_manual_corrections/Correcting_for_Scattered_Light_in_IR_Exposures_by_Manually_Subtracting_Bad_Reads.ipynb,

_toc.yml

@@ -65,7 +65,7 @@ parts:
       - file: notebooks/WFC3/exception_report/wfc3_exception_report.ipynb
 #      - file: notebooks/WFC3/filter_transformations/filter_transformations.ipynb
 #      - file: notebooks/WFC3/flux_conversion_tool/flux_conversion_tool.ipynb
-#      - file: notebooks/WFC3/image_displayer_analyzer/wfc3_image_displayer_analyzer.ipynb
+      - file: notebooks/WFC3/image_displayer_analyzer/wfc3_image_displayer_analyzer.ipynb
 #      - file: notebooks/WFC3/ir_ima_visualization/IR_IMA_Visualization_with_an_Example_of_Time_Variable_Background.ipynb
 #      - file: notebooks/WFC3/ir_scattered_light_calwf3_corrections/Correcting_for_Scattered_Light_in_IR_Exposures_Using_calwf3_to_Mask_Bad_Reads.ipynb
 #      - file: notebooks/WFC3/ir_scattered_light_manual_corrections/Correcting_for_Scattered_Light_in_IR_Exposures_by_Manually_Subtracting_Bad_Reads.ipynb

notebooks/WFC3/image_displayer_analyzer/README.md

@@ -1,21 +1,26 @@
-In this tutorial, we present `display_image`, a tool for displaying full images with metadata, individual WFC3/UVIS chip images, a section of an image with various colormaps/scaling, and individual WFC3/IR `ima` reads. In addition, we present `row_column_stats`, a tool for computing row and column statistics for the types of WFC3 images previously mentioned.
+In this tutorial, we present `display_image`, a tool for displaying full images with metadata, individual WFC3/UVIS chip images, 
+a section of an image with various colormaps/scaling, and individual WFC3/IR `ima` reads. In addition, we present 
+`row_column_stats`, a tool for computing row and column statistics for the types of WFC3 images previously mentioned.
 
 This directory, once unzipped, should contain this `README.md`,
 the image displayer tool `display_image.py`, the row and column statistic
-tool `row_column_stats.py`, and the Jupyter Notebook tutorial
-`wfc3_imageanalysis.ipynb`. Both of these tools are meant to be used inside of
-a Jupyter Notebook.
+tool `row_column_stats.py`, a `requirements.txt` file for creating a virtual 
+environment, and the Jupyter Notebook tutorial `wfc3_imageanalysis.ipynb`. 
+These tools are meant to be used inside a Jupyter Notebook.
 
-In order to run the Jupyter Notebook you must create the virtual
-environment in [WFC3 Library's](https://github.com/spacetelescope/WFC3Library)
-installation instructions. No additional packages are required to run this
-Jupyter Notebook.
+To run this Jupyter Notebook, you must have created a virtual environment that contains (at minimum) the packages listed in the 
+requirements.txt file that is included within the repository. We recommend creating a new conda environment using the requirements file:
 
-These tools (specifically `display_image`) look much better in Jupyter Lab
-rather than the classic Jupyter Notebook.  If your environment has Jupyter Lab
-installed it's recommended you use that to run the `.ipynb` file. If you're
-interested in adding Jupyter Lab to your environment see the install
-instructions on the [Jupyter website](https://jupyter.org/install).
+```
+$ conda create -n img_disp python=3.11
+$ conda activate img_disp
+$ pip install -r requirements.txt
+```
 
-Questions or concerns should be sent to the [HST Help Desk](https://stsci.service-now.com/hst).
+The tools in this notebook (specifically `display_image`) look much
+better in Jupyter Lab rather than in the classic Jupyter Notebook. If your
+environment has Jupyter Lab installed it's recommended you use that to run the
+.ipynb file. See the [Jupyter website](https://jupyter.org/install) for more info.
+
+Please submit any questions or comments to the [WFC3 Help Desk](https://stsci.service-now.com/hst).
 ---------------------------------------------------------------------