From 5c295144e259350739c870925130675d170556db Mon Sep 17 00:00:00 2001 From: Rosalie McGurk Date: Thu, 31 Oct 2024 10:53:16 -1000 Subject: [PATCH 1/9] added mention of 3.12 on index and installing --- docs/source/index.rst | 5 +++-- docs/source/installing.rst | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 717eaee..028fd49 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -5,10 +5,10 @@ KCWI_DRP is a the official data reduction pipeline (DRP) for the Keck Cosmic Web This DRP has been developed by the KCWI team at Caltech in collaboration with the W. M. Keck Observatory Scientific Software Group. -Release 1.1 +Release 1.2 =========== -We are excited to announce the release version of 1.1.0 of the KCWI DRP, now with support for +We are excited to announce the release version of 1.2.0 of the KCWI DRP, now with support for both the red and blue sides of the instrument. Just like version 1.0, this pipeline is based off of the original KCWIdrp IDL pipeline developed by the KCWI team at Caltech, and this pipeline continues to be the only pipeline supported @@ -24,6 +24,7 @@ Features * Full traceability of DRP versions and execution steps in HISTORY headers * Versatile sky subtraction modes including using external sky frames, ability to manually mask regions, or skipping it entirely * Formal support system via GitHub issues +* Added support for Mac intel M2 and M3 chips in Python 3.12 For older versions, see :doc:`versions`. diff --git a/docs/source/installing.rst b/docs/source/installing.rst index 661e629..54bbaa5 100644 --- a/docs/source/installing.rst +++ b/docs/source/installing.rst @@ -40,7 +40,7 @@ and activate it. .. code-block:: bash - conda create --name kcwidrp python=3.7 + conda create --name kcwidrp python=3.12 conda activate kcwidrp From 747d15044bb79bb86ac53a26f74d1fa68e640f89 Mon Sep 17 00:00:00 2001 From: Max Brodheim Date: Thu, 31 Oct 2024 11:12:08 -1000 Subject: [PATCH 2/9] Add warning to not use setup.py directly --- docs/source/installing.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/source/installing.rst b/docs/source/installing.rst index 54bbaa5..4dc260b 100644 --- a/docs/source/installing.rst +++ b/docs/source/installing.rst @@ -74,6 +74,12 @@ all the requirements needed for the pipeline. pip install kcwidrp + .. warning :: + Installing the pipeline by directly invoking `setup.py` is not recommended. + This method does not install the required dependencies in the recommended way, + and may lead to conflicts with other packages on your system. + + Installing From Source ---------------------- From 636ec9d0631da161cfd1a4e4221a42a5da8f5c2f Mon Sep 17 00:00:00 2001 From: Max Brodheim Date: Thu, 31 Oct 2024 11:12:28 -1000 Subject: [PATCH 3/9] add DS_Store to gitignore for all us gross Mac users --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index ea94e3e..6342b18 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ *__pycache__* /build build/ +*DS_Store \ No newline at end of file From 843171d84c5ca752c29ded66bef2b3db4e79d002 Mon Sep 17 00:00:00 2001 From: Max Brodheim Date: Thu, 31 Oct 2024 11:18:36 -1000 Subject: [PATCH 4/9] fix formating on installation instructions --- docs/source/installing.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/source/installing.rst b/docs/source/installing.rst index 4dc260b..824584d 100644 --- a/docs/source/installing.rst +++ b/docs/source/installing.rst @@ -74,10 +74,9 @@ all the requirements needed for the pipeline. pip install kcwidrp - .. warning :: - Installing the pipeline by directly invoking `setup.py` is not recommended. - This method does not install the required dependencies in the recommended way, - and may lead to conflicts with other packages on your system. +Installing the pipeline by directly invoking `setup.py` is not recommended. +This method does not install the required dependencies in the recommended way, +and may lead to conflicts with other packages on your system. Installing From Source From 35422e26341dcc974d23fc8bed0ab5cf375662e8 Mon Sep 17 00:00:00 2001 From: Max Brodheim Date: Thu, 31 Oct 2024 11:20:02 -1000 Subject: [PATCH 5/9] update front page --- docs/source/index.rst | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 028fd49..cf33718 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -8,19 +8,20 @@ collaboration with the W. M. Keck Observatory Scientific Software Group. Release 1.2 =========== -We are excited to announce the release version of 1.2.0 of the KCWI DRP, now with support for -both the red and blue sides of the instrument. Just like version 1.0, this -pipeline is based off of the original KCWIdrp IDL pipeline developed by the KCWI -team at Caltech, and this pipeline continues to be the only pipeline supported -by the W. M. Keck Observatory. +We are excited to announce the release version of 1.2.0 of the KCWI DRP! +Like version 1.1, this version now with support for both the red and blue sides +of the instrument. This pipeline is based off of the original KCWIdrp IDL pipeline +developed by the KCWI team at Caltech, and this pipeline continues to be the only +pipeline supported by the W. M. Keck Observatory. -Features --------- + +New Features +------------ * Simplified installation via pip and conda environment * Vacuum to air and heliocentric or barycentric correction -* Ability of using KOA file names or original file names [COMING SOON] +* Ability of using KOA file names or original file names * Full traceability of DRP versions and execution steps in HISTORY headers * Versatile sky subtraction modes including using external sky frames, ability to manually mask regions, or skipping it entirely * Formal support system via GitHub issues From 9a9c6090c24179f0990053fa84ead591797bd094 Mon Sep 17 00:00:00 2001 From: Max Brodheim Date: Thu, 31 Oct 2024 11:31:19 -1000 Subject: [PATCH 6/9] Add KCWIKit reference to home page --- docs/source/index.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/source/index.rst b/docs/source/index.rst index cf33718..df8c17c 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -52,12 +52,34 @@ Follow the documentation in this section to reduce KCWI data. More information ================ +For more information on the internals of the pipeline, see the following sections: .. toctree:: :maxdepth: 1 pipeline_concepts api +Helpful Packages +================ + +The following packages might be helpful to users working with reduced KCWI data. +Please note that these packages are not maintained or developed by W. M. Keck Observatory +or the KCWI team at Caltech. Rather, these are community-developed packages that +are listed only for convenience. If you utilize any of these packages, please +ensure that you properly cite their developers in addition to the KCWI DRP's. + +KCWIKit +------- +`KCWIKit`_. is a community developed +package to extend the official KCWI DRP with a +variety of stacking tools and DRP improvements. The software offers masking and +median filtering scripts to be used while running the KCWI DRP, and a step-by-step +KCWI_DRP implementation for finer control over the reduction process. Once the DRP +has finished, KCWIKit can be used to stack the output cubes via the Montage package. +Various functions cross-correlate and mosaic the constituent cubes and the final +stacked cubes are WCS corrected. Helper functions can then be used to deproject +the stacked cube into lower-dimensional representations should the user desire. + Developers ========== From 1ea5158da1fb7f9c0c63162f8067dd0812a22998 Mon Sep 17 00:00:00 2001 From: Max Brodheim Date: Thu, 31 Oct 2024 11:37:40 -1000 Subject: [PATCH 7/9] add old versions to previous versions page --- docs/source/versions.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/source/versions.rst b/docs/source/versions.rst index a5b2cbd..615ba47 100644 --- a/docs/source/versions.rst +++ b/docs/source/versions.rst @@ -4,6 +4,22 @@ Previous versions ================= + + +Version 1.1.0 (2023) +-------------------- +Added support for red-side data reduction. + +Version 1.0 (2021) +------------------ + +* Simplified installation via pip and conda environment +* Vacuum to air and heliocentric or barycentric correction (the algorithms used here are courtesy of Yuguang Chen at Caltech) +* Ability of using KOA file names or original file names +* Better provenance and traceability of DRP versions and execution steps in the headers +* Versatile sky subtraction modes including using external sky frames and ability of masking regions + + Version 0.1 (2019) ------------------ From 66d0f974d15874ba9094d9f89c6eb2124886bcce Mon Sep 17 00:00:00 2001 From: Max Brodheim Date: Thu, 31 Oct 2024 11:37:55 -1000 Subject: [PATCH 8/9] fix typo in Other packages section --- docs/source/index.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index df8c17c..00cdb96 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -59,8 +59,8 @@ For more information on the internals of the pipeline, see the following section pipeline_concepts api -Helpful Packages -================ +Other Helpful Packages +====================== The following packages might be helpful to users working with reduced KCWI data. Please note that these packages are not maintained or developed by W. M. Keck Observatory @@ -70,7 +70,7 @@ ensure that you properly cite their developers in addition to the KCWI DRP's. KCWIKit ------- -`KCWIKit`_. is a community developed +`KCWIKit `_. is a community developed package to extend the official KCWI DRP with a variety of stacking tools and DRP improvements. The software offers masking and median filtering scripts to be used while running the KCWI DRP, and a step-by-step @@ -83,7 +83,7 @@ the stacked cube into lower-dimensional representations should the user desire. Developers ========== -The DRP was developed in collaboration between: +The KCWI DRP was developed in collaboration between: * Don Neill, Matt Matuszewki, Nik Prusinski, Chris Martin and the KCWI Team at Caltech * Max Brodheim, Luca Rizzi, and Rosalie McGurk at W. M. Keck Observatory From 0a73c71783366be9eb189ae7b4b62cad89b42b51 Mon Sep 17 00:00:00 2001 From: Max Brodheim Date: Thu, 31 Oct 2024 11:46:19 -1000 Subject: [PATCH 9/9] fix typos, bold citation statement --- docs/source/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 00cdb96..f8fb203 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -65,12 +65,12 @@ Other Helpful Packages The following packages might be helpful to users working with reduced KCWI data. Please note that these packages are not maintained or developed by W. M. Keck Observatory or the KCWI team at Caltech. Rather, these are community-developed packages that -are listed only for convenience. If you utilize any of these packages, please -ensure that you properly cite their developers in addition to the KCWI DRP's. +are listed only for convenience. **If you utilize any of these packages, please +ensure that you properly cite their developers in addition to the KCWI DRP's.** KCWIKit ------- -`KCWIKit `_. is a community developed +`KCWIKit `_ is a community developed package to extend the official KCWI DRP with a variety of stacking tools and DRP improvements. The software offers masking and median filtering scripts to be used while running the KCWI DRP, and a step-by-step