-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
commit updated doc build and changes in docstrings
- Loading branch information
Showing
13 changed files
with
752 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,8 @@ | ||
|
|
||
| Nasapy Documentation | ||
| ==================== | ||
|
|
||
| :code:`nasapy` is a Python wrapper for the `nasa.gov API <https://api.nasa.gov/>`_. | ||
|
|
||
| Contents | ||
| ======== | ||
|
|
@@ -8,4 +11,213 @@ Contents | |
| :maxdepth: 1 | ||
|
|
||
| api.rst | ||
| versions.rst | ||
| versions.rst | ||
|
|
||
| Installation | ||
| ============ | ||
|
|
||
| :code:`nasapy` is most easily installed using :code:`pip`. | ||
|
|
||
| .. code-block:: console | ||
| pip install nasapy | ||
| The library can also be cloned or downloaded into a location of your choosing and then installed using the `setup.py` | ||
| file per the following: | ||
|
|
||
| .. code-block:: console | ||
| git clone [email protected]:aschleg/nasapy.git | ||
| cd nasapy | ||
| python setup.py install | ||
| Examples and Usage | ||
| ================== | ||
|
|
||
| Although not strictly required to begin interacting with the NASA API, it is recommended to sign up | ||
| to receive an `API access key <https://api.nasa.gov/>`_ that has a significantly higher usage limit available compared | ||
| to the demo key option. Many methods do not require an API key, but for those that do, it is typically a good option to | ||
| use a provided API key rather than the demo key. Using a received API key allows for 1,000 requests per hour, while the | ||
| demo key has 30 requests limit per hour and 50 requests per day. | ||
|
|
||
| Authentication | ||
| -------------- | ||
|
|
||
| Assuming an API key was received after signing up, authentication to the NASA API happens when initializing the | ||
| :code:`Nasa` class. | ||
|
|
||
| .. code-block:: python | ||
| nasa = Nasa(key=key) | ||
| If using a demo key, the initialization does not require any parameters to be passed. | ||
|
|
||
| .. code-block:: python | ||
| nasa = Nasa() | ||
| Remaining Requests Available | ||
| ---------------------------- | ||
|
|
||
| The :code:`limit_remaining` attribute of the initialized :code:`Nasa` class allows one to see the number of available | ||
| requests remaining. | ||
|
|
||
| .. code-block:: python | ||
| nasa.limit_remaining | ||
| Examples | ||
| -------- | ||
|
|
||
| The following are some quick examples to get started. | ||
|
|
||
| Astronomy Picture of the Day | ||
| ++++++++++++++++++++++++++++ | ||
|
|
||
| .. code-block:: python | ||
| # Return today's picture of the day | ||
| nasa.picture_of_the_day() | ||
| # Return a previous date's picture of the day with the high-definition URL included. | ||
| nasa.picture_of_the_day('2019-01-01', hd=True) | ||
| Mars Weather | ||
| ++++++++++++ | ||
|
|
||
| .. code-block:: python | ||
| # Return the most recent data for the previous seven Sols (Martian Days) | ||
| nasa.mars_weather() | ||
| Asteroid Feed | ||
| +++++++++++++ | ||
|
|
||
| .. code-block:: python | ||
| # Get asteroids approaching Earth at the beginning of 2019. | ||
| nasa.asteroid_feed(start_date='2019-01-01') | ||
| Get Asteroid Data | ||
| +++++++++++++++++ | ||
|
|
||
| .. code-block:: python | ||
| # Get entire asteroid data set. | ||
| nasa.get_asteroids() | ||
| # Get asteroid with ID 3542519 | ||
| nasa.get_asteroids(asteroid_id=3542519) | ||
| DONKI (Space Weather Database of Notifications, Knowledge and Information) | ||
| ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ | ||
|
|
||
| .. code-block:: python | ||
| # Coronal Mass Ejection Event Data | ||
| # View data from coronal mass ejection events from the last thirty days | ||
| nasa.coronal_mass_ejection() | ||
| # View all CME events from the beginning of 2019. | ||
| nasa.coronal_mass_ejection(start_date='2019-01-01', end_date=datetime.datetime.today()) | ||
| # Geomagnetic Storm Event Data | ||
| # Get geomagnetic storm events from the last thirty days. | ||
| nasa.geomagnetic_storm() | ||
| # Solar Flare Event Data | ||
| # Get solar flare events from May of 2019 | ||
| nasa.solar_flare(start_date='2019-05-01', end_date='2019-05-31') | ||
| # Solar Energetic Particle Data | ||
| # Get data from April 2017 | ||
| nasa.solar_energetic_particle(start_date='2017-04-01', end_date='2017-04-30') | ||
| # Magnetopause Crossing Data | ||
| # Get data on magnetopause crossing events from 2018 to the current date. | ||
| nasa.magnetopause_crossing(start_date='2018-01-01') | ||
| # Radiation Belt Enhancement Data | ||
| # Get data on radiation belt enhancement events from the last 30 days. | ||
| nasa.radiation_belt_enhancement() | ||
| # Hight Speed Stream Data | ||
| # Get data on hight speed stream events from the beginning of September 2019. | ||
| nasa.hight_speed_stream() | ||
| # WSA Enlil-Simulation Data | ||
| # Get data from the first simulation performed in 2019. | ||
| wsa = n.wsa_enlil_simulation(start_date='2019-01-01') | ||
| wsa[0] | ||
| EPIC (DSCOVR's Earth Polychromatic Imaging Camera) | ||
| ++++++++++++++++++++++++++++++++++++++++++++++++++ | ||
|
|
||
| .. code-block:: python | ||
| # Get EPIC data from the beginning of 2019. | ||
| e = nasa.epic(date='2019-01-01') | ||
| # Print the first result | ||
| e[0] | ||
| Landsat Images for a given Latitude-Longitude | ||
| +++++++++++++++++++++++++++++++++++++++++++++ | ||
|
|
||
| .. code-block:: python | ||
| # Get imagery at latitude 1.5, longitude 100.75 and include the computed cloud score calculation. | ||
| nasa.earth_imagery(lon=100.75, lat=1.5, cloud_score=True) | ||
| # Get assets available beginning from 2014-02-01 at lat-lon 100.75, 1.5 | ||
| nasa.earth_assets(lat=100.75, lon=1.5, begin_date='2014-02-01') | ||
| Available Image data collected by the Mars rovers Curiosity, Discovery and Spirit. | ||
| ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ | ||
|
|
||
| .. code-block:: python | ||
| # Return image data collected on Curiosity's 1000th sol. | ||
| nasa.mars_rover(sol=1000) | ||
| Access GeneLab and Other Bioinformatics Databases | ||
| +++++++++++++++++++++++++++++++++++++++++++++++++ | ||
|
|
||
| .. code-block:: python | ||
| # Find Gene studies in the cgene database related to 'mouse liver' | ||
| n.genelab_search(term='mouse liver') | ||
| CelesTrak Two-Line Element Set Records | ||
| ++++++++++++++++++++++++++++++++++++++ | ||
|
|
||
| .. code-block:: python | ||
| # Retrieve available data for a specific satellite ID. | ||
| tle(satellite_number=43553) | ||
| Search for Available Imagery and Audio from the images.nasa.gov API | ||
| +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ | ||
|
|
||
| .. code-block:: python | ||
| # Search for media related to 'apollo 11' with 'moon landing' in the description of the items. | ||
| r = media_search(query='apollo 11', description='moon landing') | ||
| # Print the first returned media item from the resulting collection. | ||
| r['items'][0] | ||
| Getting the Julian and Modified Julian Date | ||
| +++++++++++++++++++++++++++++++++++++++++++ | ||
|
|
||
| .. code-block:: python | ||
| # Return the modified Julian Date for the current time. | ||
| julian_date() | ||
| # Return the non-modified Julian Date for the current time. | ||
| julian_date(modified=False) | ||
| # Get the modified Julian Date for 2019-01-01 at midnight. | ||
| julian_date(year=2019) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.