update fast readme and rst

jiashuwu89 · Oct 1, 2024 · b1cd8f0 · b1cd8f0
1 parent ceca38b
commit b1cd8f0
Show file tree

Hide file tree

Showing 10 changed files with 333 additions and 29 deletions.
diff --git a/docs/source/_static/fast_acb.png b/docs/source/_static/fast_acb.png
diff --git a/docs/source/_static/fast_acf.png b/docs/source/_static/fast_acf.png
diff --git a/docs/source/_static/fast_dcb.png b/docs/source/_static/fast_dcb.png
diff --git a/docs/source/_static/fast_dcf.png b/docs/source/_static/fast_dcf.png
diff --git a/docs/source/_static/fast_esa.png b/docs/source/_static/fast_esa.png
diff --git a/docs/source/_static/fast_teams.png b/docs/source/_static/fast_teams.png
diff --git a/docs/source/fast.rst b/docs/source/fast.rst
@@ -3,9 +3,10 @@ Fast Auroral Snapshot Explorer (FAST)
 The routines in this module can be used to load data from the Fast Auroral Snapshot Explorer (FAST) mission.
 
 
-Fluxgate Magnetometer (DCB)
+Fluxgate Magnetometer (DCF)
 ----------------------------------------------------------
-.. autofunction:: pyspedas.fast.dcb
+.. autofunction:: pyspedas.fast.dcf
+
 
 Example
 ^^^^^^^^^
@@ -14,19 +15,39 @@ Example
    
    import pyspedas
    from pytplot import tplot
-   dcb_vars = pyspedas.fast.dcb(trange=['1998-09-05', '1998-09-06'])
-   tplot('')
+   dcf_vars = pyspedas.fast.dcf(trange=["1996-12-01", "1996-12-02"])
+   tplot(['fast_dcf_DeltaB_GEI'])
 
-.. image:: _static/fast_dcb.png
+.. image:: _static/fast_dcf.png
    :align: center
    :class: imgborder
 
 
 
+Search-coil Magnetometer (ACF)
+----------------------------------------------------------
+.. autofunction:: pyspedas.fast.acf
+
+Example
+^^^^^^^^^
 
-Search-coil Magnetometer (ACB)
+.. code-block:: python
+   
+   import pyspedas
+   from pytplot import tplot
+   acf_vars = pyspedas.fast.acf(trange=["1996-12-01", "1996-12-02"])
+   tplot('fast_acf_HF_E_SPEC')
+
+.. image:: _static/fast_acf.png
+   :align: center
+   :class: imgborder
+
+
+
+
+Electrostatic Analyzers (ESA)
 ----------------------------------------------------------
-.. autofunction:: pyspedas.fast.acb
+.. autofunction:: pyspedas.fast.esa
 
 Example
 ^^^^^^^^^
@@ -35,16 +56,17 @@ Example
    
    import pyspedas
    from pytplot import tplot
-   acb_vars = pyspedas.fast.acb()
-   tplot('HF_E_SPEC')
+   esa_vars = pyspedas.fast.esa(trange=["1996-12-01", "1996-12-02"])
+   tplot('fast_esa_eflux')
 
-.. image:: _static/fast_acb.png
+.. image:: _static/fast_esa.png
    :align: center
    :class: imgborder
 
 
 
 
+
 Time-of-flight Energy Angle Mass Spectrograph (TEAMS)
 ----------------------------------------------------------
 .. autofunction:: pyspedas.fast.teams
@@ -56,8 +78,8 @@ Example
    
    import pyspedas
    from pytplot import tplot
-   teams_vars = pyspedas.fast.teams(trange=['1998-09-05', '1998-09-06'])
-   tplot(['H+', 'H+_low', 'H+_high'])
+   teams_vars = pyspedas.fast.teams(trange=["2005-08-01", "2005-08-02"])
+   tplot(['fast_teams_helium_omni_flux'])
 
 .. image:: _static/fast_teams.png
    :align: center

diff --git a/pyspedas/projects/fast/README.md b/pyspedas/projects/fast/README.md
@@ -16,37 +16,34 @@ import pyspedas
 from pytplot import tplot
 ```
 
-#### Fluxgate Magnetometer (DCB)
+#### Fluxgate Magnetometer (DCF)
 
 ```python
-dcb_vars = pyspedas.fast.dcb(trange=['1998-09-05', '1998-09-06'])
-
-tplot('')
+dcf_vars = pyspedas.fast.dcf(trange=["1996-12-01", "1996-12-02"])
+tplot(['fast_dcf_DeltaB_GEI'])
 ```
 
 
-#### Search-coil Magnetometer (ACB)
+#### Search-coil Magnetometer (ACF)
 
 ```python
-acb_vars = pyspedas.fast.acb()
-
-tplot('HF_E_SPEC')
+acf_vars = pyspedas.fast.acf(trange=["1996-12-01", "1996-12-02"])
+tplot('fast_acf_HF_E_SPEC')
 ```
 
 
 #### Electrostatic Analyzers (ESA)
 
 ```python
-esa_vars = pyspedas.fast.esa(downloadonly=True)
-
+esa_vars = pyspedas.fast.esa(trange=["1996-12-01", "1996-12-02"])
+tplot('fast_esa_eflux')
 ```
 
 
 #### Time-of-flight Energy Angle Mass Spectrograph (TEAMS)
 
 ```python
-teams_vars = pyspedas.fast.teams(trange=['1998-09-05', '1998-09-06'])
-
-tplot(['H+', 'H+_low', 'H+_high'])
+teams_vars = pyspedas.fast.teams(trange=["2005-08-01", "2005-08-02"])
+tplot(['fast_teams_helium_omni_flux'])
 ```