Merge pull request #21 from GeoStat-Framework/update_IO

Enhancement: refactor data_io, Well class and author list

.zenodo.json

@@ -15,6 +15,10 @@
             "orcid": "0000-0001-9060-4008",
             "affiliation": "Helmholtz Centre for Environmental Research - UFZ",
             "name": "Sebastian M\u00fcller"
+        },
+        {
+            "affiliation": "Utrecht University - The Netherlands",
+            "name": "Jarno Herrmann"
         }
     ]
-}
+}

CHANGELOG.md

@@ -4,10 +4,18 @@ All notable changes to **welltestpy** will be documented in this file.
 
 ## [Unreleased]
 
+### Enhancements
+- added `cooper_jacob_correction` to `process` (thanks to Jarno Herrmann)
+- added `diagnostic_plots` module (thanks to Jarno Herrmann)
+- added `screensize`, `screen`, `aquifer` and `is_piezometer` attribute to `Well` class
+- added version information to output files
+- added `__repr__` to `Campaign`
+
 ### Changes
 - modernized packaging workflow using `pyproject.toml`
 - removed `setup.py` (use `pip>21.1` for editable installs)
 - removed `dev` as extra install dependencies
+- better exceptions in loading routines
 
 ### Bugfixes
 - loading steady pumping tests was not possible due to a bug

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Sebastian Mueller
+Copyright (c) 2021 Sebastian Müller, Jarno Herrmann
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docs/source/conf.py

@@ -104,8 +104,8 @@ def setup(app):
 # General information about the project.
 curr_year = datetime.datetime.now().year
 project = "welltestpy"
-copyright = "2018 - {}, Sebastian Mueller".format(curr_year)
-author = "Sebastian Mueller"
+copyright = "2018 - {}, Sebastian Müller, Jarno Herrmann".format(curr_year)
+author = "Sebastian Müller, Jarno Herrmann"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -210,7 +210,7 @@ def setup(app):
         master_doc,
         "welltestpy.tex",
         "welltestpy Documentation",
-        "Sebastian Mueller",
+        author,
         "manual",
     )
 ]

setup.cfg

@@ -4,10 +4,10 @@ description = welltestpy - package to handle well-based Field-campaigns.
 long_description = file: README.md
 long_description_content_type = text/markdown
 url = https://github.com/GeoStat-Framework/welltestpy
-author = Sebastian Mueller
-author_email = [email protected]
-maintainer = Sebastian Mueller
-maintainer_email = [email protected]
+author = Sebastian Müller, Jarno Herrmann
+author_email = [email protected]
+maintainer = Sebastian Müller
+maintainer_email = [email protected]
 license = MIT
 license_file = LICENSE
 platforms = any
@@ -50,6 +50,7 @@ install_requires =
     pandas>=0.23.2,<2
     scipy>=1.1.0,<2
     spotpy>=1.5.0,<2
+    packaging>=20
 python_requires = >=3.6
 zip_safe = False
 

welltestpy/data/campaignlib.py

@@ -471,6 +471,14 @@ def diagnostic_plot(self, pumping_test, observation_well, **kwargs):
                 f"diagnostic_plot: test '{pumping_test}' could not be found!"
             )
 
+    def __repr__(self):
+        """Representation."""
+        return (
+            f"Campaign '{self.name}' at '{self.fieldsite}' with "
+            f"{len(self.wells)} wells and "
+            f"{len(self.tests)} tests"
+        )
+
     def save(self, path="", name=None):
         """Save the campaign to file.