Skip to content

Commit bfed982

Browse files
committed
add more info for running in Colab
1 parent 72ddd2b commit bfed982

2 files changed

Lines changed: 51 additions & 1 deletion

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,7 @@ Examples are included for PACE, TEMPO, ICESat-2 ATL21, ECCO and MUR.
1515
## PyPI
1616

1717
<https://pypi.org/project/point-collocation/>
18+
19+
## Data Regions
20+
21+
This package currently is designed to do point matchups against NASA EarthData. In a virtual machine in AWS us-west-2, where NASA cloud data is, the point matchups are fast. In Colab, say, your comppute is not in the same data region nor provider (Google versus AWS), and the same matchups might take 10x longer. Thus if you have big matchup tasks, 10s of thousands of points, it is wise to do that in AWS us-west-2.

examples/docs_1_pace_l3.ipynb

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
"* Print the plan to check it `print(plan.summary())`\n",
1515
"* Do the plan and get matchups `pc.matchup(plan)`\n",
1616
"\n",
17+
"*Note*: In a virtual machine in AWS us-west-2, where NASA cloud data is, the point matchups are fast. In Colab, say, your comppute is not in the same data region nor provider (Google versus AWS), and the same matchups might take 10x longer. Thus if you have big matchup tasks, 10s of thousands of points, it is wise to do that in AWS us-west-2.\n",
18+
"\n",
1719
"## Read in some points"
1820
]
1921
},
@@ -86,6 +88,48 @@
8688
"df"
8789
]
8890
},
91+
{
92+
"cell_type": "markdown",
93+
"id": "037fb7d4-404a-4b47-89b3-1d4ebc915208",
94+
"metadata": {},
95+
"source": [
96+
"## Prerequisites"
97+
]
98+
},
99+
{
100+
"cell_type": "code",
101+
"execution_count": null,
102+
"id": "daf8b793-9495-40e0-9e7f-c9ee6445508c",
103+
"metadata": {},
104+
"outputs": [],
105+
"source": [
106+
"# install if needed\n",
107+
"pip install point-collocation --quiet"
108+
]
109+
},
110+
{
111+
"cell_type": "code",
112+
"execution_count": 1,
113+
"id": "051ddcae-f267-48f1-83cc-97c3947eb137",
114+
"metadata": {},
115+
"outputs": [
116+
{
117+
"data": {
118+
"text/plain": [
119+
"<earthaccess.auth.Auth at 0x7f4675d2bd10>"
120+
]
121+
},
122+
"execution_count": 1,
123+
"metadata": {},
124+
"output_type": "execute_result"
125+
}
126+
],
127+
"source": [
128+
"# Make sure you are logged in\n",
129+
"import earthaccess\n",
130+
"earthaccess.login()"
131+
]
132+
},
89133
{
90134
"cell_type": "markdown",
91135
"id": "c5b68c9a-8fd4-4c10-b554-11f1ba1edbfe",
@@ -1570,7 +1614,9 @@
15701614
"id": "49389bf6-adac-44cb-835e-9200951e7eaa",
15711615
"metadata": {},
15721616
"source": [
1573-
"## Get 100 matchups using that plan"
1617+
"## Get 100 matchups using that plan\n",
1618+
"\n",
1619+
"In a virtual machine in AWS us-west-2, where NASA cloud data is, this is 12 seconds. In Colab, say, this might be over a minute since you are not in the same data region nor provider (Google versus AWS).\n"
15741620
]
15751621
},
15761622
{

0 commit comments

Comments
 (0)