Merge branch 'v1.3'

Author: Unknown

.gitignore

@@ -3,6 +3,7 @@
 *.icloud
 *.rst
 *.bat
+*.so
 Makefile
 kernels/
 output/

README.md

@@ -3,15 +3,19 @@ rss_ringoccs is a suite of open-source Python-based analysis tools for Cassini R
 
 Version 1.2 was offically released on July 1, 2019.
 
+Version 1.2.1 was a development version that incorporated changes between Versions 1.2 and 1.3.
+
+Version 1.3 was officially released on August 30, 2019
+
 ## Introduction
 The Cassini Radio Science Subsystem (RSS) was used during the Cassini orbital tour of Saturn to observe a superb series of ring occultations that resulted in high-resolution, high-SNR radial profiles of Saturn's rings at three radio wavelengths: 13 cm (S band), 3.6 cm (X band), and 0.9 cm (Ka band). Radial optical depth profiles of the rings at 1- and 10-km resolution produced by the Cassini RSS team, using state of the art signal processing techniques to remove diffraction effects, are available on NASA's Planetary Data System (PDS). These archived products are likely to be quite adequate for many ring scientists, but for those who wish to generate their own diffraction-reconstructed ring profiles from Cassini RSS observations, we offer rss_ringoccs: a suite of Python-based  analysis tools for Cassini Radio Science (RSS) ring occultations.
 
 The purpose of rss_ringoccs is to enable scientists to produce "on demand" radial optical depth profiles of Saturn's rings from the raw RSS data, without requiring a deep familiarity with the complex processing steps involved in calibrating the data and correcting for the effects of diffraction. The code and algorithms are extensively documented, providing a starting point for users who wish to test, refine, or optimize the straightforward methods we have employed. Our emphasis has been on clarity, sometimes at the expense of programming efficiency and execution time. rss_ringoccs does an excellent job of reproducing existing 1 km-resolution RSS processed ring occultation data already present on NASA's PDS Ring-Moons Node, but we make no claim to having achieved the state-of-the-art in every respect. We encourage users to augment our algorithms and to report on those improvements, so that they can be  incorporated in future editions of rss_ringoccs. 
 
 ## Installation and Documentation
-Detailed installation instructions and full documentation are contained the `rss_ringoccs User Guide` at https://github.com/NASA-Planetary-Science/rss_ringoccs/tree/master/docs/rss_ringoccs_User_Guide_V1.2.pdf. 
+Detailed installation instructions and full documentation are contained the `rss_ringoccs User Guide` at https://github.com/NASA-Planetary-Science/rss_ringoccs/tree/master/docs/rss_ringoccs_User_Guide_V1.3.pdf. 
 
-For experienced users, we provide a `rss_ringoccs Quick Start` guide located at https://github.com/NASA-Planetary-Science/rss_ringoccs/tree/master/docs/rss_ringoccs_Quick_Start_V1.2.pdf
+For experienced users, we provide a `rss_ringoccs Quick Start` guide located at https://github.com/NASA-Planetary-Science/rss_ringoccs/tree/master/docs/rss_ringoccs_Quick_Start_V1.3.pdf
 
 Release notes are contained in https://github.com/NASA-Planetary-Science/rss_ringoccs/blob/master/ReleaseNotes.md
 

ReleaseNotes.md

@@ -1,8 +1,46 @@
 # Release Notes #
 
+
+## rss_ringoccs V1.3 ##
+
+Release date: 2019 August 30
+
+### Changes from V1.2 ###
+
+1. Fix minor typographical errors in user Guide.
+
+2. Clearer explanation of differences between end-to-end batch processing scripts.
+
+3. C code implemented for diffraction reconstruction and special functions.
+
+4. Support restricted to Anaconda Python for compatibility reasons.
+
+5. Enhance post-USO support. This includes addressing the discontinuous frequency offsets and modeling the phase echo introduced by diffraction of the uplink signal by the ring system.
+
+6. Runnable scripts to perform push-button diffraction correction, starting either from raw RSS files or from Essam Marouf's (or our) PDS-style geometry, calibration, and diffraction-limited profiles, at any desired resolution (consistent with the sampling theorem and justified by the SNR), for the full set of RSS occultations at S, X, and Ka-band up to the point of USO failure.
+
+**Resolved V1.2-2**
+Some post-USO files contain discontinuous frequency offsets. rss_rings v1.3 now supports the processing of these files.
+
+### Known Issues and Limitations of V1.3 ###
+
+#### V1.3-1 (carried over from V1.2-1) ####
+For the extreme nearly edge-on viewing geometry of Rev133E at X-band, rss_ringoccs gives slightly different results from PDS, traceable to a difference of about 10% in the cubic term of the varaiable psi. The origin of this discrepancy is unknown, but it is not important for any other occultation data sets we have reduced so far, and is relatively minor even for Rev133E at X band.
+
+#### V1.3-2 ####
+Support for egress occultations at start of proximal orbits in the Grand Finale not yet implemented.
+
+### Lien list for V1.3 ###
+
+1. Properly proximal egress occultations in Grand Finale orbits
+
+2. Data catalog query - we will work with the PDS to ensure that our recently-submitted RSS ring occultation observation data catalog is compliant with current PDS search capabilities.
+
+3. Improve processing and documenting of the scattered signal. This should include appropriate Doppler footprint contours and correcting the observed frequency drift to account for wavelength-dependents and motion of the spacecraft.
+
 ## rss_ringoccs V1.2 ##
 
-Release date: 2019 Jun 30
+Release date: 2019 July 1
 
 ### Changes from V1.1 ###
 
@@ -38,13 +76,6 @@ For the extreme nearly edge-on viewing geometry of Rev133E at X-band, rss_ringoc
 #### V1.2-2 ####
 Some post-USO files contain discontinuous frequency offsets. rss_rings v1.2 does not support the processing of these files.
 
-### Lien list for V1.3 ###
-
-1. Complete post-USO support. This includes addressing the discontinuous frequency offsets and the phase echo introduced by diffraction of the uplink signal by the ring system.
-
-2. Data catalog query - we will work with the PDS to ensure that our recently-submitted RSS ring occultation observation data catalog is compliant with current PDS search capabilities.
-
-3. Improve processing and documenting of the scattered signal. This should include appropriate Doppler footprint contours and correcting the observed frequency drift to account for wavelength-dependents and motion of the spacecraft.
 
 
 ## rss_ringoccs V1.1 ##

docs/conf.py

@@ -17,7 +17,7 @@
 sys.path.append('../')
 import rss_ringoccs
 sys.path.remove('../')
-sys.path.insert(0, '/Volumes/sflury001/Research/TC2017/sflury/rss_ringoccs/rss_ringoccs')
+sys.path.insert(0, '/Volumes/rmaguire001/Research/TC2017/rmaguire/rss_ringoccs/rss_ringoccs')
 
 
 # -- Project information -----------------------------------------------------
@@ -27,9 +27,9 @@
 author = 'Richard French (PI), Sophia Flury, Jolene Fong,\n Ryan Maquire, and Glenn Steranka'
 
 # The short X.Y version
-version = 'v1.1'
+version = 'v1.2'
 # The full version, including alpha/beta/rc tags
-release = 'v1.1'
+release = 'v1.2'
 
 
 # -- General configuration ---------------------------------------------------