Merge pull request #157 from pysat/doc/152_icon_const

DOC: ICON constellation info

CHANGELOG.md

@@ -20,6 +20,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 * Documentation
   * Added TIMED-GUVI platform
   * Added missing sub-module imports
+  * Added discussion of ICON constellation to docstrings, including caveats
 * Enhancements
   * Updated platform methods to follow a consistent style and work with the
     general `init` function

pysatNASA/constellations/de2.py

@@ -1,4 +1,21 @@
-"""Creates a constellation from the NASA DE2 satellite platform."""
+"""Creates a constellation from the NASA DE2 satellite platform.
+
+Includes the core supported instruments.
+
+
+Examples
+--------
+::
+
+    import pysat
+    import pysatNASA
+
+    de2 = pysat.Constellation(const_module=pysatNASA.constellations.de2)
+
+    de2.load(1983, 1)
+
+
+"""
 
 import pysat
 

pysatNASA/constellations/icon.py

@@ -1,4 +1,24 @@
-"""Creates a constellation from NASA the ICON satellite platform."""
+"""Creates a constellation from NASA the ICON satellite platform.
+
+Includes the core instruments without the line of sight winds.
+
+Note that IVM A and B are nominally never active at the same time. This
+constellation should be initialized with `common_index=False`.  This forgoes
+the pysat check that ensures all instruments load data.
+
+Examples
+--------
+::
+
+    import pysat
+    import pysatNASA
+
+    icon = pysat.Constellation(const_module=pysatNASA.constellations.icon,
+                               common_index=False)
+
+    icon.load(2020, 1)
+
+"""
 
 import pysat