Skip to content

Commit c0581e1

Browse files
geohanggeohang
committed
update
1 parent 5163213 commit c0581e1

34 files changed

Lines changed: 1490 additions & 2300 deletions

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
3838
- Updated main documentation index to include data processing
3939
- Added workflow examples for time-lapse ERT surveys
4040
- Documented all 14+ supported instrument types with usage examples
41+
- Added RESIPY citation in README and documentation
4142

4243
### Dependencies
4344
- Added `resipy>=3.4.0` as optional dependency under `geophysics` extras

‎README.md‎

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -342,22 +342,39 @@ If you use PyHydroGeophysX in your research, please cite:
342342

343343
```bibtex
344344
@software{chen2025pyhydrogeophysx,
345-
author = {Chen, Hang, Niu, Qifei, Wu, Yuxin},
345+
author = {Chen, Hang and Niu, Qifei and Wu, Yuxin},
346346
title = {PyHydroGeophysX: An Extensible Open-Source Platform for Bridging Hydrological Models and Geophysical Measurements},
347347
year = {2025},
348348
publisher = {Water Resources Research (under review)},
349349
url = {https://github.com/geohang/PyHydroGeophysX}
350350
}
351351
```
352352

353+
Additionally, if you use the ERT data processing module, please cite RESIPY:
354+
355+
```bibtex
356+
@article{blanchy2020resipy,
357+
title={ResIPy, an intuitive open source software for complex geoelectrical inversion/modeling},
358+
author={Blanchy, Guillaume and Saneiyan, Sina and Boyd, Jimmy and McLachlan, Paul and Binley, Andrew},
359+
journal={Computers \& Geosciences},
360+
volume={137},
361+
pages={104423},
362+
year={2020},
363+
publisher={Elsevier},
364+
doi={10.1016/j.cageo.2020.104423}
365+
}
366+
```
367+
353368
## 📄 License
354369

355370
This project is licensed under the Apache-2.0 license - see the LICENSE file for details.
356371

357372
## 🙏 Acknowledgments
358373

359-
- PyGIMLi team for the excellent geophysical modeling framework
360-
- MODFLOW and ParFlow communities for hydrologic modeling tools
374+
- **RESIPY** developers (Guillaume Blanchy, Jimmy Boyd, and contributors) for the excellent ERT data processing library that powers our field data workflows
375+
- **PyGIMLi** team for the outstanding geophysical modeling framework
376+
- **MODFLOW** and **ParFlow** communities for hydrologic modeling tools
377+
- All open-source contributors and users providing valuable feedback
361378

362379
## 📧 Contact
363380

‎UPDATE_SUMMARY.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,10 +230,14 @@ pip install resipy
230230
## Acknowledgments
231231

232232
This update builds on the excellent RESIPY library for ERT data processing. Special thanks to:
233-
- RESIPY development team
234-
- PyGIMLi community
233+
- **RESIPY development team** (Guillaume Blanchy, Jimmy Boyd, and contributors) for creating an intuitive and powerful ERT data processing framework
234+
- **PyGIMLi community** for the geophysical modeling infrastructure
235235
- All contributors and users providing feedback
236236

237+
**RESIPY Citation:**
238+
239+
Blanchy, G., Saneiyan, S., Boyd, J., McLachlan, P., & Binley, A. (2020). ResIPy, an intuitive open source software for complex geoelectrical inversion/modeling. *Computers & Geosciences*, 137, 104423. https://doi.org/10.1016/j.cageo.2020.104423
240+
237241
## Next Steps
238242

239243
1. **Publish to PyPI** following RELEASE.md guide

‎docs/build/html/.doctrees/api/Geophy_modular.doctree‎

-84.8 KB
Binary file not shown.

‎docs/build/html/.doctrees/api/PyHydroGeophysX.doctree‎

-573 KB
Binary file not shown.

‎docs/build/html/.doctrees/api/core.doctree‎

290 KB
Binary file not shown.

‎docs/build/html/.doctrees/api/index.doctree‎

27 Bytes
Binary file not shown.

‎docs/build/html/.doctrees/environment.pickle‎

-26.3 KB
Binary file not shown.

‎docs/build/html/.doctrees/quickstart.doctree‎

2.89 KB
Binary file not shown.

‎docs/build/html/_modules/Hydro_modular/hydro_to_ert.html‎

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,25 @@
1+
2+
13
<!DOCTYPE html>
2-
<html class="writer-html5" lang="en" >
4+
<html class="writer-html5" lang="en" data-content_root="../../">
35
<head>
46
<meta charset="utf-8" />
57
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
68
<title>Hydro_modular.hydro_to_ert &mdash; PyHydroGeophysX Documentation</title>
7-
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
8-
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
9-
<link rel="stylesheet" href="../../_static/copybutton.css" type="text/css" />
10-
<link rel="stylesheet" href="../../_static/sg_gallery.css" type="text/css" />
11-
<link rel="stylesheet" href="../../_static/sg_gallery-binder.css" type="text/css" />
12-
<link rel="stylesheet" href="../../_static/sg_gallery-dataframe.css" type="text/css" />
13-
<link rel="stylesheet" href="../../_static/sg_gallery-rendered-html.css" type="text/css" />
14-
<link rel="canonical" href="https://geohang.github.io/PyHydroGeophysX/_modules/Hydro_modular/hydro_to_ert.html" />
15-
<!--[if lt IE 9]>
16-
<script src="../../_static/js/html5shiv.min.js"></script>
17-
<![endif]-->
9+
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
10+
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
11+
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css?v=d2d258e8" />
12+
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-binder.css?v=f4aeca0c" />
13+
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-dataframe.css?v=2082cf3c" />
14+
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-rendered-html.css?v=1277b6f3" />
15+
1816

19-
<script src="../../_static/jquery.js?v=5d32c60e"></script>
20-
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
21-
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=2389946f"></script>
22-
<script src="../../_static/doctools.js?v=888ff710"></script>
23-
<script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
24-
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
25-
<script src="../../_static/copybutton.js?v=f281be69"></script>
26-
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
17+
<link rel="canonical" href="https://geohang.github.io/PyHydroGeophysX/_modules/Hydro_modular/hydro_to_ert.html" />
18+
<script src="../../_static/jquery.js?v=5d32c60e"></script>
19+
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
20+
<script src="../../_static/documentation_options.js?v=01f34227"></script>
21+
<script src="../../_static/doctools.js?v=9bcbadda"></script>
22+
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
2723
<script src="../../_static/js/theme.js"></script>
2824
<link rel="index" title="Index" href="../../genindex.html" />
2925
<link rel="search" title="Search" href="../../search.html" />
@@ -90,18 +86,20 @@ <h1>Source code for Hydro_modular.hydro_to_ert</h1><div class="highlight"><pre>
9086
<span></span><span class="sd">&quot;&quot;&quot;</span>
9187
<span class="sd">Module for converting hydrologic model output to ERT apparent resistivity.</span>
9288
<span class="sd">&quot;&quot;&quot;</span>
93-
<span class="kn">import</span> <span class="nn">os</span>
94-
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
95-
<span class="kn">import</span> <span class="nn">pygimli</span> <span class="k">as</span> <span class="nn">pg</span>
96-
<span class="kn">from</span> <span class="nn">pygimli.physics</span> <span class="kn">import</span> <span class="n">ert</span>
97-
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Tuple</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Union</span><span class="p">,</span> <span class="n">List</span>
89+
<span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
90+
<span class="kn">import</span><span class="w"> </span><span class="nn">numpy</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">np</span>
91+
<span class="kn">import</span><span class="w"> </span><span class="nn">pygimli</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">pg</span>
92+
<span class="kn">from</span><span class="w"> </span><span class="nn">pygimli.physics</span><span class="w"> </span><span class="kn">import</span> <span class="n">ert</span>
93+
<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Tuple</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Union</span><span class="p">,</span> <span class="n">List</span>
9894

99-
<span class="kn">from</span> <span class="nn">PyHydroGeophysX.core.interpolation</span> <span class="kn">import</span> <span class="n">ProfileInterpolator</span>
100-
<span class="kn">from</span> <span class="nn">PyHydroGeophysX.petrophysics.resistivity_models</span> <span class="kn">import</span> <span class="n">water_content_to_resistivity</span>
101-
<span class="kn">from</span> <span class="nn">PyHydroGeophysX.forward.ert_forward</span> <span class="kn">import</span> <span class="n">ERTForwardModeling</span>
95+
<span class="kn">from</span><span class="w"> </span><span class="nn">PyHydroGeophysX.core.interpolation</span><span class="w"> </span><span class="kn">import</span> <span class="n">ProfileInterpolator</span>
96+
<span class="kn">from</span><span class="w"> </span><span class="nn">PyHydroGeophysX.petrophysics.resistivity_models</span><span class="w"> </span><span class="kn">import</span> <span class="n">water_content_to_resistivity</span>
97+
<span class="kn">from</span><span class="w"> </span><span class="nn">PyHydroGeophysX.forward.ert_forward</span><span class="w"> </span><span class="kn">import</span> <span class="n">ERTForwardModeling</span>
10298

10399

104-
<div class="viewcode-block" id="hydro_to_ert"><a class="viewcode-back" href="../../api/Hydro_modular.html#Hydro_modular.hydro_to_ert.hydro_to_ert">[docs]</a><span class="k">def</span> <span class="nf">hydro_to_ert</span><span class="p">(</span>
100+
<div class="viewcode-block" id="hydro_to_ert">
101+
<a class="viewcode-back" href="../../api/Hydro_modular.html#Hydro_modular.hydro_to_ert.hydro_to_ert">[docs]</a>
102+
<span class="k">def</span><span class="w"> </span><span class="nf">hydro_to_ert</span><span class="p">(</span>
105103
<span class="n">water_content</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span>
106104
<span class="n">porosity</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span>
107105
<span class="n">mesh</span><span class="p">:</span> <span class="n">pg</span><span class="o">.</span><span class="n">Mesh</span><span class="p">,</span>
@@ -272,6 +270,7 @@ <h1>Source code for Hydro_modular.hydro_to_ert</h1><div class="highlight"><pre>
272270
<span class="n">synth_data</span><span class="p">[</span><span class="s1">&#39;err&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">ert_manager</span><span class="o">.</span><span class="n">estimateError</span><span class="p">(</span><span class="n">synth_data</span><span class="p">,</span> <span class="n">absoluteUError</span><span class="o">=</span><span class="mf">0.0</span><span class="p">,</span> <span class="n">relativeError</span><span class="o">=</span><span class="mf">0.05</span><span class="p">)</span>
273271

274272
<span class="k">return</span> <span class="n">synth_data</span><span class="p">,</span> <span class="n">res_model</span></div>
273+
275274
</pre></div>
276275

277276
</div>

0 commit comments

Comments
 (0)