AMPERE downloads

.github/workflows/main.yml

@@ -14,7 +14,7 @@ jobs:
       matrix:
         os: ["ubuntu-latest", "macos-latest", "windows-latest"]
         python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
-        install-extras: ["base", "dmsp_ssj"]
+        install-extras: ["base", "downloads"]
         include:
           # Pysat test for only pysat-passing Python version
           - python-version: "3.10"

Changelog.rst

@@ -3,6 +3,13 @@ Changelog
 
 Summary of all changes made since the first stable release
 
+1.0.0 (XX-XX-2026)
+------------------
+* ENH: Added option to download and format AMPERE files
+* ENH: Added optional dependencies for AMPERE downloads, as well as all
+  downloads and all optional dependencies
+* DEP: Removed stored AMPERE files
+
 0.7.0 (06-05-2026)
 ------------------
 * ENH: Added the Gussenhoven (1983) model for the EAB

docs/citing.rst

@@ -76,7 +76,7 @@ also includes fits to the R1 and R2 peaks, for those interested.
   Electrodynamics Response Experiment, J. Geophys. Res. Space Physics, 120,
   doi:10.1002/2015JA021680
 * **FAC**: Milan, Stephen (2023). AMPERE R1/R2 FAC radii v2. University of
-  Leicester. Dataset. https://doi.org/10.25392/leicester.data.22241338.v3
+  Leicester. Dataset. https://doi.org/10.25392/leicester.data.22241338
 * **OCB**: Burrell, A. G., et al. (2020): AMPERE Polar Cap Boundaries,
   Ann. Geophys., 38, 481-490, http://doi.org/10.5194/angeo-38-481-2020
 

docs/ocb_datasets.rst

@@ -46,13 +46,15 @@ AMPERE
 
 OCB data sets can also be obtained from AMPERE (Active Magnetosphere and
 Planetary Electrodynamics Response Experiment) R1/R2 Field-Aligned Current (FAC)
-boundary data.  This data is provided for both hemispheres between 2010-2021,
-inclusive. Because there is an offset between the R1/R2 FAC boundary and the
-OCB, a correction is required.  This correction can be implemented using the
-routines in :py:mod:`ocbpy.ocb_correction`.
-
-In the most recent version
-(`V2 <https://figshare.le.ac.uk/articles/dataset/AMPERE_R1_R2_FAC_radii_v2/22241338/1>`_)
+boundary data.  This data may be obtained for both hemispheres between
+2010-2024, inclusive, using the downloading and formatting functions in
+:py:mod:`ocbpy.boundaries.ampere_r1r2_files`. Because there is an offset
+between the R1/R2 FAC boundary and the OCB, a correction is required.  This
+correction can be implemented using the routines in
+:py:mod:`ocbpy.ocb_correction`.
+
+In the most recent
+`version <https://figshare.le.ac.uk/articles/dataset/AMPERE_R1_R2_FAC_radii_v2/22241338>`_
 of these AMPERE boundary fits, which uses the newly-processed AMPERE data, a fit
 for the Heppner-Maynard Boundary (HMB) were also made available. The HMB has
 been shown to be related to the equatorward boundary of the auroral oval near

ocbpy/boundaries/__init__.py

@@ -16,3 +16,8 @@
     from ocbpy.boundaries import dmsp_ssj_files  # noqa F401
 except ImportError as ierr:
     logger.warning(ierr)
+
+try:
+    from ocbpy.boundaries import ampere_r1r2_files  # noqa F401
+except ImportError as ierr:
+    logger.warning(ierr)