Merge pull request #7336 from meeseeksmachine/auto-backport-of-pr-732…

…9-on-5.1 Backport PR #7329 on branch 5.1 (Add Clarification on setting Environment Variable for JSOC Email)
sunpy · Dec 7, 2023 · f26d433 · f26d433
2 parents 2c3281f + 5033b28
commit f26d433
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 8 deletions.
diff --git a/changelog/7329.doc.rst b/changelog/7329.doc.rst
@@ -0,0 +1 @@
+Added Clarification on setting JSOC Email.
diff --git a/examples/acquiring_data/downloading_cutouts.py b/examples/acquiring_data/downloading_cutouts.py
@@ -35,11 +35,10 @@
 cutout = a.jsoc.Cutout(bottom_left, top_right=top_right, tracking=True)
 
 #####################################################
-# Exporting data from the JSOC requires registering your
-# email first. Please replace this with your email
-# address once you have registered.
-# See `this page <http://jsoc.stanford.edu/ajax/register_email.html>`_
-# for more details.
+# Exporting data from the JSOC requires registering your email first.
+# Please replace this with your email address once you have registered
+# like so: jsoc_email = "your_email@example.com"
+# See `this page <http://jsoc.stanford.edu/ajax/register_email.html>`__ for more details.
 
 jsoc_email = os.environ["JSOC_EMAIL"]
 

diff --git a/examples/acquiring_data/fido_metadata_queries.py b/examples/acquiring_data/fido_metadata_queries.py
@@ -21,8 +21,11 @@
 
 timerange = a.Time('2010/8/1 03:40', '2010/8/1 3:40:10')
 
-# Note that JSOC needs an email address to export the files, if you want to run
-# this, you must supply your own email here.
+# Exporting data from the JSOC requires registering your email first.
+# Please replace this with your email address once you have registered
+# like so: jsoc_email = "your_email@example.com"
+# See `this page <http://jsoc.stanford.edu/ajax/register_email.html>`__ for more details.
+
 jsoc_email = os.environ["JSOC_EMAIL"]
 
 results = Fido.search(timerange,

diff --git a/examples/acquiring_data/querying_and_loading_SHARP_data.py b/examples/acquiring_data/querying_and_loading_SHARP_data.py
@@ -21,8 +21,10 @@
 # and make use of the search attributes in `sunpy.net.jsoc` that allow us to query the JSOC.
 #
 # Exporting data from the JSOC requires registering your email first.
-# Please replace this with your email address once you have registered.
+# Please replace this with your email address once you have registered
+# like so: jsoc_email = "your_email@example.com"
 # See `this page <http://jsoc.stanford.edu/ajax/register_email.html>`__ for more details.
+
 jsoc_email = os.environ["JSOC_EMAIL"]
 
 result = Fido.search(a.Time("2011-03-09 23:20:00", "2011-03-09 23:30:00"),