diff --git a/gliderpy/fetchers.py b/gliderpy/fetchers.py index 427d11c..5d52167 100644 --- a/gliderpy/fetchers.py +++ b/gliderpy/fetchers.py @@ -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 """ diff --git a/notebooks/00-quick_intro.ipynb b/notebooks/00-quick_intro.ipynb index 59443b6..a1e827e 100644 --- a/notebooks/00-quick_intro.ipynb +++ b/notebooks/00-quick_intro.ipynb @@ -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:" ] }, { @@ -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." ] }, { @@ -128,7 +112,7 @@ "source": [ "### Dataset search\n", "\n", - "One can query all datasets available." + "One can query all dataset_ids available." ] }, { @@ -162,7 +146,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.11.3" + "version": "3.11.4" } }, "nbformat": 4, diff --git a/requirements-dev.txt b/requirements-dev.txt index 7d75aca..77d68bc 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -2,7 +2,7 @@ cartopy check-manifest jupyter matplotlib -nbconvert<7.3.0 +nbconvert nbsphinx palettable pre-commit diff --git a/requirements.txt b/requirements.txt index 0ee4a51..bc59429 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,4 @@ erddapy httpx pandas +xarray