You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,14 +36,14 @@ it requires no special tools beyond your web browser.
36
36
See [this website](https://spacetelescope.github.io/hst_notebooks/)
37
37
38
38
To download and execute the notebooks, we recommend you clone
39
-
the `hst_notebooks <https://github.com/spacetelescope/hst_notebooks>`_
39
+
the `hst_notebooks <https://github.com/spacetelescope/hst_notebooks>`
40
40
repository to your local computer.
41
41
42
42
You can also click the "Download ZIP" option for the entire repository listed under the green "Code" button at the top of the repository landing page. You are also able to download individual notebooks, but it is not as straight forward or recommended, so we do not provide details here.
43
43
44
44
Most notebooks have additional associated files in their folder,
45
45
including a requirements file that lists packages necessary to run the notebooks.
46
-
The packages in the requirements file can be installed using `pip <https://pip.pypa.io/en/stable/>`_ .
46
+
The packages in the requirements file can be installed using `pip <https://pip.pypa.io/en/stable/>`.
47
47
48
48
Any version dependencies are contained in the requirements file in
49
49
each notebook folder. Please use at least the minimum supported
@@ -69,12 +69,12 @@ You can then proceed to install the requirements for the specific notebook you a
69
69
Run the notebook in an appropriate environment
70
70
----------------------------------------------
71
71
72
-
Once you are in the directory of the notebook you want to use, make sure you have a populated environment that contains the required pacages::
72
+
Once you are in the directory of the notebook you want to use, make sure you have a populated environment that contains the required packages:
73
73
74
74
cd hst_notebooks/notebooks/<notebook-name>
75
75
76
76
You may want to consider installing your notebooks in a new conda/mamba environment
77
-
to avoid version conflicts with other packages you may have installed, for example::
77
+
to avoid version conflicts with other packages you may have installed, for example:
Copy file name to clipboardExpand all lines: notebooks/ACS/README.md
+14-9Lines changed: 14 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,31 +15,36 @@ Jupyter Notebooks allow code to be packaged with formatted text to create illust
15
15
16
16
17
17
## Before Running a Notebook
18
-
Before running these examples you **must** follow the general instructions on creating an environment that can run the notebooks, shown in STScI HST Notebook Repository HQ page under [Installation Instructions](https://spacetelescope.github.io/hst_notebooks/index.html).
18
+
Before running these examples, you **must** follow the general instructions on creating an environment that can run the notebooks, shown in STScI HST Notebook Repository HQ page under [**Installation Instructions**](https://spacetelescope.github.io/hst_notebooks/index.html).
19
19
20
20
21
21
## Contents
22
22
23
23
### Simple Example Notebooks
24
24
25
-
***acs_subarrays**: Instructions for how to use the `acstools.acs_destripe_plus` module to calibrate, de-stripe, and correct ACS subarray observations for charge transfer efficiency (CTE). Also included are instructions for updating the `OSCNTAB` reference file to subtract the bias level from the prescan columns in user-defined subarray observations.
25
+
*[**acs_subarrays**](https://spacetelescope.github.io/hst_notebooks/notebooks/ACS/acs_subarrays/acs_subarrays.html): Instructions for how to use the `acstools.acs_destripe_plus` module to calibrate, de-stripe, and correct ACS subarray observations for charge transfer efficiency (CTE). Also included are instructions for updating the `OSCNTAB` reference file to subtract the bias level from the prescan columns in user-defined subarray observations.
26
26
27
-
***acs_pixel_area_maps**: This notebook shows how to use Python to create pixel area maps (PAMs) to account for the effects of geometric distortion in distorted images. This enables users to perform photometry on distorted images.
27
+
*[**acs_pixel_area_maps**](https://spacetelescope.github.io/hst_notebooks/notebooks/ACS/acs_pixel_area_maps/acs_pixel_area_maps.html): This notebook shows how to use Python to create pixel area maps (PAMs) to account for the effects of geometric distortion in distorted images. This enables users to perform photometry on distorted images.
28
28
29
-
***acs_polarization_tools**: ACS/WFC offers two sets of polarizers, UV and visible, for imaging polarimetry and imaging spectropolarimetry. This notebook provides guidance on using the `acstools.polarization_tools` module to retrieve polarization calibration coefficients and calculate polarization properties of a source.
29
+
*[**acs_polarization_tools**](https://spacetelescope.github.io/hst_notebooks/notebooks/ACS/acs_polarization_tools/acs_polarization_tools.html): ACS/WFC offers two sets of polarizers, UV and visible, for imaging polarimetry and imaging spectropolarimetry. This notebook provides guidance on using the `acstools.polarization_tools` module to retrieve polarization calibration coefficients and calculate polarization properties of a source.
30
+
31
+
*[**acs_exception_report**](https://spacetelescope.github.io/hst_notebooks/notebooks/ACS/acs_exception_report/exception_report_checks.html): This notebook provides a step-by-step guide for examining your ACS data and observing logs to identify potential data quality issues via an HST Exception Report, and outlines the process for deciding whether a HOPR or Help Desk ticket is warranted.
30
32
31
33
### Complex Workflow Notebooks
32
34
33
-
***acs_reduction**: This worked example demonstrates how to use the CALACS pipeline to re-process raw ACS data retrieved from MAST. Users are shown how to update reference files in the image headers, retrieve reference files from the Calibration Reference Data System (CRDS), and how to toggle steps in the calibration pipeline (e.g., CTE correction).
35
+
*[**acs_reduction**](https://spacetelescope.github.io/hst_notebooks/notebooks/ACS/acs_reduction/acs_reduction.html): This worked example demonstrates how to use the CALACS pipeline to re-process raw ACS data retrieved from MAST. Users are shown how to update reference files in the image headers, retrieve reference files from the Calibration Reference Data System (CRDS), and how to toggle steps in the calibration pipeline (e.g., CTE correction).
36
+
37
+
*[**acs_cte_forward_model**](https://spacetelescope.github.io/hst_notebooks/notebooks/ACS/acs_cte_forward_model/acs_cte_forward_model_example.html): The capability to simulate the readout of an ACS image at a given epoch is a feature of CALACS that does not run during standard calibration. This example demonstrates how to take a pristine image, or one corrected for time-dependent CTE loss, and simulate CTE losses for an arbitrary observation date using `acstools.acscteforwardmodel`.
34
38
35
-
***acs_cte_forward_model** The capability to simulate the readout of an ACS image at a given epoch is a feature of CALACS that does not run during standard calibration. This example demonstrates how to take a pristine image, or one corrected for time-dependent CTE loss, and simulate CTE losses for an arbitrary observation date using `acstools.acscteforwardmodel`.
39
+
*[**acs_saturation_trails**](https://spacetelescope.github.io/hst_notebooks/notebooks/ACS/acs_saturation_trails/acs_saturation_trails.html): The ACS/WFC CCDs remain linear beyond the full-well saturation, which allows users the opportunity to perform photometry on saturated stars. This notebook demonstrates the methods and caveats when performing saturated star photometry.
36
40
37
-
***acs_saturation_trails** The ACS/WFC CCDs remain linear beyond the full-well saturation, which allows users the opportunity to perform photometry on saturated stars. This notebook demonstrates the methods and caveats when performing saturated star photometry.
41
+
*[**acs_sbc_dark_analysis**](https://spacetelescope.github.io/hst_notebooks/notebooks/ACS/acs_sbc_dark_analysis/acs_sbc_dark_analysis.html): The ACS Solar Blind Channel (SBC) has nominally negligible dark current. However, the temperature of the SBC detector increases steadily over time while it is in use, and the dark current is proportional to temperature. At temperatures above 25 ºC, the dark current is no longer negligible and must be subtracted. This workflow demonstrates how to account for dark current in ACS/SBC observations.
38
42
39
-
***acs_sbc_dark_analysis**: The ACS Solar Blind Channel (SBC) has nominally negligible dark current. However, the temperature of the SBC detector increases steadily over time while it is in use, and the dark current is proportional to temperature. At temperatures above 25 ºC, the dark current is no longer negligible and must be subracted. This workflow demonstrates how to account for dark current in ACS/SBC observations.
43
+
*[**acs_findsat_mrt_example**](https://spacetelescope.github.io/hst_notebooks/notebooks/ACS/acs_findsat_mrt/acs_findsat_mrt_example.html): ACS/WFC imaging data is often affected by contamination by artificial satellites, compromising science data. The `acstools.findsat_mrt` module can be used to identify satellite trails and create masks to reject affected pixels from further analysis.
40
44
41
-
***acs_findsat_mrt_example.ipynb**: ACS/WFC imaging data is often affected by contamination by artificial satellites, compromising science data. The `acstools.findsat_mrt` module can be used to identify satellite trails and create masks to reject affected pixels from further analysis.
45
+
*[**acs_focus_diverse_epsfs**](https://spacetelescope.github.io/hst_notebooks/notebooks/ACS/acs_focus_diverse_epsfs/acs_focus_diverse_epsfs.html): This notebook provides instructions on using the `acstools.focus_diverse_epsfs` module to retrieve empirical, focus-diverse ePSFs for ACS/WFC data.
42
46
47
+
*[**hst_orbits_ephem**](https://spacetelescope.github.io/hst_notebooks/notebooks/ACS/hst_orbits_ephem/hst_orbits_ephem.html): Instructions on how to obtain information about HST’s location and pointing direction relative to Earth and the Sun for a given observation.
Copy file name to clipboardExpand all lines: notebooks/ACS/acs_focus_diverse_epsfs/acs_focus_diverse_epsfs.ipynb
+2-4Lines changed: 2 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -400,7 +400,7 @@
400
400
"id": "041df5ae",
401
401
"metadata": {},
402
402
"source": [
403
-
"## For more help:\n",
403
+
"### For more help:\n",
404
404
"\n",
405
405
"More details may be found on the [ACS website](http://www.stsci.edu/hst/instrumentation/acs) and in the [ACS Instrument](https://hst-docs.stsci.edu/display/ACSIHB) and [Data Handbooks](https://hst-docs.stsci.edu/acsdhb).\n",
0 commit comments