Skip to content

Commit

Permalink
Merge pull request #207 from ArtesiaWater/dev
Browse files Browse the repository at this point in the history
Release 0.11.2
  • Loading branch information
OnnoEbbens authored Apr 11, 2024
2 parents 4a06b01 + 0e49840 commit 64c34f7
Show file tree
Hide file tree
Showing 28 changed files with 10,106 additions and 5,296 deletions.
37 changes: 1 addition & 36 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ On this page you will find all the information to get started with `hydropandas`

Getting Python
--------------
To install `hydropandas`, a working version of Python 3.7 or higher has to be
To install `hydropandas`, a working version of Python 3.9 or higher has to be
installed on your computer. We recommend using the
`Anaconda Distribution <https://www.continuum.io/downloads>`_
of Python.
Expand All @@ -17,41 +17,6 @@ Installing hydropandas
Install the module by typing::

pip install hydropandas

Please note that some of the dependencies cannot be installed automatically
on Windows. If you do not have these packages already you can install them
manually using the following instructions:

Download these packages from `Christoph Gohlke's website <https://www.lfd.uci.edu/~gohlke/pythonlibs>`_ :

- GDAL
- Fiona
- Shapely
- Python-snappy
- Fastparquet

Use CTRL+F to find the download link on the page. Be sure to download the
correct version of the package. The Python version should match your Python
version. Also the architecture should match (i.e. 64bits vs 32bits). For example:

- GDAL-3.1.4-cp38-cp38-win_amd64.whl

This is the GDAL version for Python `3.8` (as can be seen from the `cp38` in the name),
for `64-bits` Python (as derived from the `amd64` in the name).

Once you have downloaded the correct files, open Anaconda Prompt, and navigate to
the directory in which you saved your downloads. Now use the following commands
to install the packages (the order is important)::

pip install GDAL-3.1.4-cp38-cp38-win_amd64.whl
pip install Fiona-1.8.17-cp38-cp38-win_amd64.whl
pip install Shapely-1.7.1-cp38-cp38-win_amd64.whl
pip install python_snappy-0.5.4-cp38-cp38-win_amd64.whl
pip install fastparquet-0.4.1-cp38-cp38-win_amd64.whl

After you've done this you can install hydropandas using::

pip install hydropandas

For installing in development mode, clone the repository and install by
typing the following from the module root directory::
Expand Down
34 changes: 21 additions & 13 deletions docs/source/hydropandas.io.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
hydropandas.io package
======================

hydropandas.io.arctic module
--------------------------------
hydropandas.io.bro module
------------------------------

.. automodule:: hydropandas.io.arctic
.. automodule:: hydropandas.io.bro
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -17,10 +17,10 @@ hydropandas.io.dino module
:undoc-members:
:show-inheritance:

hydropandas.io.fieldlogger module
-------------------------------------
hydropandas.io.fews module
------------------------------

.. automodule:: hydropandas.io.fieldlogger
.. automodule:: hydropandas.io.fews
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -33,6 +33,14 @@ hydropandas.io.knmi module
:undoc-members:
:show-inheritance:

hydropandas.io.lizard module
------------------------------

.. automodule:: hydropandas.io.lizard
:members:
:undoc-members:
:show-inheritance:

hydropandas.io.menyanthes module
------------------------------------

Expand All @@ -57,10 +65,10 @@ hydropandas.io.pastas module
:undoc-members:
:show-inheritance:

hydropandas.io.pystore module
---------------------------------
hydropandas.io.solinst module
--------------------------------

.. automodule:: hydropandas.io.pystore
.. automodule:: hydropandas.io.solinst
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -81,10 +89,10 @@ hydropandas.io.wiski module
:undoc-members:
:show-inheritance:

hydropandas.io.fews module
------------------------------
hydropandas.io.wow module
-------------------------------

.. automodule:: hydropandas.io.fews
.. automodule:: hydropandas.io.wow
:members:
:undoc-members:
:show-inheritance:
:show-inheritance:
4 changes: 3 additions & 1 deletion examples/01_groundwater_observations.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -1873,7 +1873,9 @@
"source": [
"# read using a .zip file with data\n",
"dinozip = \"data/dino.zip\"\n",
"dino_gw = hpd.read_dino(dirname=dinozip, keep_all_obs=False)\n",
"dino_gw = hpd.read_dino(\n",
" dirname=dinozip, subdir=\"Grondwaterstanden_Put\", suffix=\"1.csv\", keep_all_obs=False\n",
")\n",
"dino_gw"
]
},
Expand Down
2,731 changes: 72 additions & 2,659 deletions examples/02_knmi_observations.ipynb

Large diffs are not rendered by default.

10 changes: 6 additions & 4 deletions examples/03_hydropandas_and_pastas.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -872,7 +872,9 @@
"source": [
"extent = [117850, 117980, 439550, 439700] # Schoonhoven zuid-west\n",
"dinozip = \"data/dino.zip\"\n",
"oc_dino = hpd.read_dino(dirname=dinozip, keep_all_obs=False)\n",
"oc_dino = hpd.read_dino(\n",
" dirname=dinozip, subdir=\"Grondwaterstanden_Put\", suffix=\"1.csv\", keep_all_obs=False\n",
")\n",
"oc_dino = oc_dino.loc[\n",
" [\"B58A0092-004\", \"B58A0092-005\", \"B58A0102-001\", \"B58A0167-001\", \"B58A0212-001\"]\n",
"]\n",
Expand Down Expand Up @@ -1248,9 +1250,9 @@
],
"metadata": {
"kernelspec": {
"display_name": "hpd_env",
"display_name": "dev",
"language": "python",
"name": "python3"
"name": "dev"
},
"language_info": {
"codemirror_mode": {
Expand All @@ -1262,7 +1264,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.12"
"version": "3.10.13"
}
},
"nbformat": 4,
Expand Down
2 changes: 1 addition & 1 deletion hydropandas/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,6 @@
WaterlvlObs,
WaterQualityObs,
)
from .version import __version__
from .version import __version__, show_versions

logging.getLogger("hydropandas").addHandler(logging.NullHandler())
Loading

0 comments on commit 64c34f7

Please sign in to comment.