Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add quickstart to README #549

Merged
merged 4 commits into from
Aug 21, 2024
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,32 @@ Alternatively, you can also install icepyx using `pip <https://pip.pypa.io/en/st
More detailed instructions for installing `icepyx` can be found at
https://icepyx.readthedocs.io/en/latest/getting_started/install.html

Quick start
mfisher87 marked this conversation as resolved.
Show resolved Hide resolved
-----------

.. code-block:: python

import icepyx as ipx
query = ipx.Query(
# Collection short name
"ATL06",
# Bounding box
[-55, 68, -48, 71],
# Time bounds
['2019-02-20','2019-02-28'],
)
query.download_granules('/tmp/icepyx')

.. code-block:: bash

$ ls -1 /tmp/icepyx/
processed_ATL06_20190221121851_08410203_006_02.h5
processed_ATL06_20190222010344_08490205_006_02.h5
processed_ATL06_20190225121032_09020203_006_02.h5
processed_ATL06_20190226005526_09100205_006_02.h5

See the examples below for more things `icepyx` can do!


Examples (Jupyter Notebooks)
----------------------------
Expand Down