Skip to content

Commit 976e973

Browse files
authored
Merge pull request #803 from cgre-aachen/gempy_v2023.1.0_readme
Remove Version Warnings and Add Information about DEPs
2 parents d6abe3d + 1fbb7a8 commit 976e973

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,6 @@
1111
[![DOI](https://zenodo.org/badge/96211155.svg)](https://zenodo.org/badge/latestdoi/96211155)
1212
[![DOCKER](https://img.shields.io/docker/cloud/automated/leguark/gempy.svg)](https://cloud.docker.com/repository/docker/leguark/gempy)
1313

14-
:warning: **Warning: GemPy requires pandas version < 1.4.0. The new pandas release is not compatible with GemPy.
15-
We're actively working on this issue for a future release.
16-
Please make sure to use Pandas version 1.3.x when working with GemPy for the time being.**
17-
18-
**Using theano, GemPy requires numpy version < 1.22.0 as `blas_opt_info` was deprecated in newer numpy versions.**:warning:
1914
## Overview
2015

2116
[GemPy](https://www.gempy.org/) is a Python-based, **open-source geomodeling library**. It is
@@ -40,9 +35,17 @@ the aesara conda installation. Therefore the process would be the following:
4035

4136
For more information, refer to the [installation documentation](https://docs.gempy.org/installation.html).
4237

38+
## Requirements
39+
40+
The following versions are required/strongly recommended for the main dependencies of GemPy (as of June 2023):
41+
- python>=3.10
42+
- pandas>=2.0
43+
- matplotlib>=3.7
44+
- pyvista>=0.39
45+
4346
## Resources
4447

45-
After installation you can either check the [notebook tutorials](https://docs.gempy.org/getting_started/get_started.html#sphx-glr-getting-started-get-started-py)
48+
After installation, you can either check the [notebook tutorials](https://docs.gempy.org/getting_started/get_started.html#sphx-glr-getting-started-get-started-py)
4649
or the [video introduction](https://www.youtube.com/watch?v=n0btC5Zilyc) to get started.
4750

4851
Go to the [documentation site](http://docs.gempy.org/) for further information and enjoy the [tutorials and examples](https://www.gempy.org/tutorials).
@@ -58,8 +61,8 @@ Follow these [guidelines](https://github.com/cgre-aachen/gempy/blob/WIP_readme-u
5861

5962
* de la Varga, M., Schaaf, A., and Wellmann, F. (2019). [GemPy 1.0: open-source stochastic geological modeling and inversion](https://gmd.copernicus.org/articles/12/1/2019/gmd-12-1-2019.pdf), Geosci. Model Dev., 12, 1-32.
6063
* Wellmann, F., & Caumon, G. (2018). [3-D Structural geological models: Concepts, methods, and uncertainties.](https://hal.univ-lorraine.fr/hal-01921494/file/structural_models_for_geophysicsHAL.pdf) In Advances in Geophysics (Vol. 59, pp. 1-121). Elsevier.
61-
* Calcagno, P., Chilès, J. P., Courrioux, G., & Guillen, A. (2008). Geological modelling from field data and geological knowledge: Part I. Modelling method coupling 3D potential-field interpolation and geological rules. Physics of the Earth and Planetary Interiors, 171(1-4), 147-157.
62-
* Lajaunie, C., Courrioux, G., & Manuel, L. (1997). Foliation fields and 3D cartography in geology: principles of a method based on potential interpolation. Mathematical Geology, 29(4), 571-584.
64+
* Calcagno, P., Chilès, J. P., Courrioux, G., & Guillen, A. (2008). [Geological modelling from field data and geological knowledge: Part I. Modelling method coupling 3D potential-field interpolation and geological rules](https://www.sciencedirect.com/science/article/abs/pii/S0031920108001258). Physics of the Earth and Planetary Interiors, 171(1-4), 147-157.
65+
* Lajaunie, C., Courrioux, G., & Manuel, L. (1997). [Foliation fields and 3D cartography in geology: principles of a method based on potential interpolation](https://link.springer.com/article/10.1007/BF02775087). Mathematical Geology, 29(4), 571-584.
6366

6467
## Publications using GemPy
6568

0 commit comments

Comments
 (0)