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

Minor doc changes #68

Merged
merged 6 commits into from
Oct 12, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion gliderpy/fetchers.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ class GliderDataFetcher:

Attributes:
dataset_id: a dataset unique id.
constraints: download constraints, default None (opendap-like url)
constraints: download constraints, default

"""

Expand Down
26 changes: 5 additions & 21 deletions notebooks/00-quick_intro.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"With gliderpy attain the same output as erddapy with fewer lines and a cleaner UI."
"And here is how to use gliderpy to obtain the same results but with fewer lines and a cleaner code:"
]
},
{
Expand All @@ -79,34 +79,18 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The variable names are also standardised by gliderpy\n",
"\n",
"### Single dataset\n",
"The variable names are standardised by gliderpy, making it easier to fetch from different data sources and comparing the results.\n",
"\n",
"`gliderpy` can subset the data on the server side by passing a geographic bounding box and time interval."
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"glider_grab = GliderDataFetcher()\n",
"glider_grab.fetcher.dataset_id = \"whoi_406-20160902T1700\"\n",
"glider_grab.query(38, 41, -72, -69, \"2016-09-20T01:00:00\", \"25th sept 2016\")\n",
"\n",
"df = glider_grab.to_pandas()\n",
"df.head()"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Multiple datasets\n",
"\n",
"If a user does not specify a `dataset_id`, `gliderpy` will search all datasets for data that falls within the query bounds."
"The most common use is to search all datasets for data that falls within the certain space-time bounds."
]
},
{
Expand All @@ -128,7 +112,7 @@
"source": [
"### Dataset search\n",
"\n",
"One can query all datasets available."
"One can query all dataset_ids available."
]
},
{
Expand Down Expand Up @@ -162,7 +146,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.3"
"version": "3.11.4"
}
},
"nbformat": 4,
Expand Down
2 changes: 1 addition & 1 deletion requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ cartopy
check-manifest
jupyter
matplotlib
nbconvert<7.3.0
nbconvert
nbsphinx
palettable
pre-commit
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
erddapy
httpx
pandas
xarray