Skip to content

Commit

Permalink
- [DOC] Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Leguark committed Oct 11, 2023
1 parent 9fe3737 commit 0753fbb
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 236 deletions.
27 changes: 9 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,15 @@
[![PyPI](https://img.shields.io/badge/python-3-blue.svg)](https://www.python.org/downloads/)
[![PyPI](https://img.shields.io/badge/pypi-1.0-blue.svg)](https://pypi.org/project/gempy/)
[![license: LGPL v3](https://img.shields.io/badge/license-LGPL%20v3-blue.svg)](https://github.com/cgre-aachen/gempy/blob/master/LICENSE)
[![license: EUPL v1.2](https://img.shields.io/badge/license-EUPL%20v1.2-blue.svg)](https://github.com/cgre-aachen/gempy/blob/master/LICENSE)
[![Documentation Status](https://assets.readthedocs.org/static/projects/badges/passing-flat.svg)](http://docs.gempy.org)
[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/cgre-aachen/gempy/master)
[![DOI](https://zenodo.org/badge/96211155.svg)](https://zenodo.org/badge/latestdoi/96211155)
[![DOCKER](https://img.shields.io/docker/cloud/automated/leguark/gempy.svg)](https://cloud.docker.com/repository/docker/leguark/gempy)

## What is New!

GemPy 3 is getting readding for release. We are currently working on the documentation and the final touches. Learn more about the new features in the [What's new in GemPy 3](WhatsNewGemPy3.md). You can try GemPy 3 by installing the pre-release version from PyPi:

`$ pip install gempy --pre`

## Overview

Expand All @@ -23,25 +27,12 @@ We provide the latest release version of GemPy via PyPi package services. We hig

`$ pip install gempy`

as it will take care of automatically installing all the required dependencies - except in windows that requires one extra step.

Windows does not have a gcc compilers pre-installed. The easiest way to get a aesara compatible compiler is by using
the aesara conda installation. Therefore the process would be the following:

`$ conda install aesara`

`$ pip install gempy`

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

## Requirements

The following versions are required/strongly recommended for the main dependencies of GemPy (as of June 2023):
- python=3.10
- pandas=2.0.1
- matplotlib>=3.7
- pyvista>=0.39

- numpy

## Resources

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)
Expand Down
47 changes: 37 additions & 10 deletions WhatsNewGemPy3.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,37 @@
### Points to treat

- [ ] New features
- [ ] Data orientated
- [ ] Robustness
- [ ] Dependencies hell
- Only numpy required
- [ ] Lean
- [ ] What will happen with gempy 2
- Gempy legacy
Introducing GemPy Version 3: A Leap Forward in Geomodeling Software

Welcome to the era of GemPy v3! We are thrilled to announce the release of the latest version, a product of meticulous planning, redesign, and rigorous testing. While the core essence remains intact, v3 brings significant enhancements and novelties that promise to revolutionize your geomodeling experience.

1. Transition from GemPy v2 to v3: The Legacy Lives On

The journey from GemPy v2 to v3 has been transformative. To ensure that our users don't lose out on any previous functionalities, we've shifted v2 to a package named gempy_legacy. While the core team will not develop any new features for this version, we'll continue maintaining it based on community requests.

2. A More Streamlined API

GemPy v3 promises a cleaner, sleeker, and more intuitive API. With a clear end-goal in mind, we've redesigned the API and data classes to optimize utility, minimize code repetition, and boost performance.

3. Parting Ways with Theano/Aesara

One significant shift is our departure from Theano/Aesara. Although these technologies served us well in the past, it's time to evolve. Ensuring the long-term viability of GemPy, v3 incorporates a flexible tensor library. Currently, it supports numpy and has optional dependencies on PyTorch. Furthermore, TensorFlow's integration is in the pipeline. Impressively, the PyTorch implementation took just a day!

4. Comprehensive Refactoring for Greater Robustness

We've overhauled the foundation of GemPy to ensure:

Enhanced State Management: By employing properties, we ensure a consistently valid state, irrespective of data modifications.
Optimized Dependency Management: The handling of dependencies is now more efficient and streamlined. Plus, most of them are optional.
Modular Design: We've divided GemPy into multiple libraries to enhance its adaptability and ease-of-use:
gempy_engine
gempy_viewer
gempy_plugins
gempy_probability (Stay tuned for this!)
gempy (Leaner and meaner, focused mainly on documentation and the API)
5. Exciting New Features on the Horizon

While the above changes are foundational, we are also gearing up to unveil some groundbreaking features. We're keeping them under wraps for now, but rest assured, they'll significantly elevate your GemPy experience!

In Conclusion

GemPy v3 is not just an upgrade; it's a transformation that ensures longevity, adaptability, and cutting-edge functionalities. We're confident that this version will redefine geomodeling standards, and we're eager to see the fantastic work you'll accomplish with it!

Stay tuned for more updates and tutorials to help you transition smoothly to GemPy v3. Your feedback, as always, is invaluable to us. So, dive into the new version and let us know your thoughts!
Empty file.
123 changes: 0 additions & 123 deletions gempy/modules/geophysics/geophysics.py

This file was deleted.

85 changes: 0 additions & 85 deletions test/test_modules/_geophysics_TO_UPDATE/test_magnetics.py

This file was deleted.

0 comments on commit 0753fbb

Please sign in to comment.