Skip to content

Commit

Permalink
Update notebook examples to include the latest features.
Browse files Browse the repository at this point in the history
  • Loading branch information
cheginit committed Feb 17, 2021
1 parent 2bfe70a commit fd8e94d
Show file tree
Hide file tree
Showing 8 changed files with 140 additions and 55 deletions.
Binary file added docs/_static/daymet_grid.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/daymet_loc.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/_static/example_plots_pydaymet.png
Binary file not shown.
Binary file added docs/_static/hi.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/pr.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
140 changes: 100 additions & 40 deletions docs/examples/daymet.ipynb

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/examples/nhdplus.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"`WaterData` gives us access to the medium-resolution NHDPlus database. We can use `NHDPlusHR` to retrieve high-resolution NHDPlus data. Let's get both medium- and high-resolution flowlines within the bounding box of our watershed and compare them."
"`WaterData` gives us access to the medium-resolution NHDPlus database. We can use `NHDPlusHR` to retrieve high-resolution NHDPlus data. Let's get both medium- and high-resolution flowlines within the bounding box of our watershed and compare them. Moreover, Since serveral web services offer access to NHDPlus database, ``NHDPlusHR`` has an argument for selecting a service and also an argument for automatically switching between services."
]
},
{
Expand All @@ -304,7 +304,7 @@
"source": [
"flw_mr = nhdp_mr.bybox(basin.geometry[0].bounds)\n",
"\n",
"nhdp_hr = NHDPlusHR(\"networknhdflowline\")\n",
"nhdp_hr = NHDPlusHR(\"networknhdflowline\", service=\"hydro\", auto_switch=True)\n",
"flw_hr = nhdp_hr.bygeom(basin.geometry[0].bounds)"
]
},
Expand Down
51 changes: 38 additions & 13 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
.. image:: _static/hydrodata_logo_text.png
:width: 50%
:alt: hydrodata
:align: left
.. image:: https://raw.githubusercontent.com/cheginit/hydrodata/develop/docs/_static/hydrodata_logo_text.png
:target: https://raw.githubusercontent.com/cheginit/hydrodata/develop/docs/_static/hydrodata_logo_text.png
:align: center

|
Expand Down Expand Up @@ -48,7 +47,7 @@ PyDaymet_ Access Daymet for daily climate data both single pixel and gridded
.. _PyDaymet: https://github.com/cheginit/pydaymet

Hydrodata: Portal to hydrology and climatology data
===================================================
---------------------------------------------------

.. image:: https://img.shields.io/pypi/v/hydrodata.svg
:target: https://pypi.python.org/pypi/hydrodata
Expand All @@ -58,22 +57,42 @@ Hydrodata: Portal to hydrology and climatology data
:target: https://anaconda.org/conda-forge/hydrodata
:alt: Conda Version

.. image:: https://pepy.tech/badge/hydrodata
:target: https://pepy.tech/project/hydrodata
:alt: Downloads
.. image:: https://codecov.io/gh/cheginit/hydrodata/graph/badge.svg
:target: https://codecov.io/gh/cheginit/hydrodata
:alt: CodeCov

.. image:: https://readthedocs.org/projects/hydrodata/badge/?version=latest
:target: https://hydrodata.readthedocs.io/en/latest/?badge=latest
:alt: ReadTheDocs

.. image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/cheginit/hydrodata/master?urlpath=lab/tree/docs/examples
:alt: Binder

|
.. image:: https://pepy.tech/badge/hydrodata
:target: https://pepy.tech/project/hydrodata
:alt: Downloads

.. image:: https://www.codefactor.io/repository/github/cheginit/hydrodata/badge/develop
:target: https://www.codefactor.io/repository/github/cheginit/hydrodata/overview/develop
:alt: CodeFactor

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: black

.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
:target: https://github.com/pre-commit/pre-commit
:alt: pre-commit

.. image:: https://zenodo.org/badge/237573928.svg
:target: https://zenodo.org/badge/latestdoi/237573928
:alt: Zenodo

|
🚨 **This package is under heavy development and breaking changes are likely to happen.** 🚨

Why Hydrodata?
--------------

Expand All @@ -98,6 +117,12 @@ it on you system by clicking on the binder badge below the Hydrodata banner. A J
instance with the Hydrodata software stack pre-installed will be launched in your web browser
and you can start coding!

Please note that since Hydrodata is in early development stages, while the provided
functionaities should be stable, changes in APIs are possible in new releases. But we
appreciate it if you give this project a try and provide feedback. Contributions are most welcome.

The full documentation can be found at https://hydrodata.readthedocs.io.

Features
--------

Expand Down Expand Up @@ -127,11 +152,11 @@ The ``helpers`` module includes:
useful for overland flow routing among other applications.
* ``nwis_error``: A dataframe for finding information about NWIS requests' errors.

Moreover, requests for additional databases or functionalities can be submitted via
Moreover, requests for additional databases and functionalities can be submitted via
`issue tracker <https://github.com/cheginit/hydrodata/issues>`__.

.. image:: _static/example_plots.png
:align: center
.. image:: https://raw.githubusercontent.com/cheginit/hydrodata/develop/docs/_static/example_plots.png
:target: https://raw.githubusercontent.com/cheginit/hydrodata/develop/docs/_static/example_plots.png

Documentation
=============
Expand Down

0 comments on commit fd8e94d

Please sign in to comment.