Skip to content

Commit 6c6366a

Browse files
Add quickstart to README (#549)
Co-authored-by: Jessica Scheick <[email protected]>
1 parent fca67b9 commit 6c6366a

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,32 @@ Alternatively, you can also install icepyx using `pip <https://pip.pypa.io/en/st
8585
More detailed instructions for installing `icepyx` can be found at
8686
https://icepyx.readthedocs.io/en/latest/getting_started/install.html
8787

88+
Quick Start
89+
-----------
90+
91+
.. code-block:: python
92+
93+
import icepyx as ipx
94+
query = ipx.Query(
95+
# Collection short name
96+
"ATL06",
97+
# Bounding box
98+
[-55, 68, -48, 71],
99+
# Time bounds
100+
['2019-02-20','2019-02-28'],
101+
)
102+
query.download_granules('/tmp/icepyx')
103+
104+
.. code-block:: bash
105+
106+
$ ls -1 /tmp/icepyx/
107+
processed_ATL06_20190221121851_08410203_006_02.h5
108+
processed_ATL06_20190222010344_08490205_006_02.h5
109+
processed_ATL06_20190225121032_09020203_006_02.h5
110+
processed_ATL06_20190226005526_09100205_006_02.h5
111+
112+
See the examples below for more things `icepyx` can do!
113+
88114

89115
Examples (Jupyter Notebooks)
90116
----------------------------

0 commit comments

Comments
 (0)