Merge pull request #3 from Keck-DataReductionPipelines/1.2.0

1.2.0

.gitignore

@@ -6,3 +6,4 @@
 *__pycache__*
 /build
 build/
+*DS_Store

docs/source/index.rst

@@ -5,25 +5,27 @@ 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
-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
+* Added support for Mac intel M2 and M3 chips in Python 3.12
 
 For older versions, see :doc:`versions`.
 
@@ -50,16 +52,38 @@ 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
 
+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.**
+
+KCWIKit
+-------
+`KCWIKit <https://github.com/yuguangchen1/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
 ==========
 
-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

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
 
 
@@ -74,6 +74,11 @@ all the requirements needed for the pipeline.
         pip install kcwidrp
 
 
+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
 ----------------------
 

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)
 ------------------