Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master'
Browse files Browse the repository at this point in the history
# Conflicts:
#	README.md
  • Loading branch information
Leguark committed Mar 6, 2020
2 parents d68c797 + 78b6111 commit ac3de52
Show file tree
Hide file tree
Showing 55 changed files with 13,597 additions and 3,317 deletions.
28 changes: 13 additions & 15 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,16 @@ assignees: ''
---

**Describe the bug**
A clear and concise description of what the bug is.
A clear and concise description of what the bug is. Include error messages /
tracebacks. If useful include screenshots.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
Provide detailed steps to reproduce the behavior:

1.
2.
3.
...

**Expected behavior**
A clear and concise description of what you expected to happen.
Expand All @@ -24,15 +26,11 @@ A clear and concise description of what you expected to happen.
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
* OS: (e.g. iOS)
* GemPy Version
* if installed via pip: provide GemPy version (e.g. 2.0.1)
* if cloned from GitHub: provide Git commit id (e.g. 839bf85f)
* Jupyter Version (if applicable)

**Additional context**
Add any other context about the problem here.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Question
about: Ask a question about GemPy
title: ''
labels: ''
assignees: ''

---

**What is your question?**
15 changes: 15 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Description
Please include a summary of the changes.

Relates to <issue>

# Checklist
- [ ] My code follows the [PEP 8 style guidelines](https://www.python.org/dev/peps/pep-0008/).
- [ ] My code uses type hinting for function and method arguments and return values.
- [ ] My code contains descriptive and helpful docstrings
which are formatted per the [Google Python Style Guidelines](http://google.github.io/styleguide/pyguide.html).
- [ ] I have created tests which entirely cover my code.
- [ ] The test code either 1. demonstrates at least one valuable use case (e.g. integration tests)
or 2. verifies that outputs are as expected for given inputs (e.g. unit tests).
- [ ] New and existing tests pass locally with my changes.

41 changes: 1 addition & 40 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,46 +8,7 @@ GeMpy/__pycache__/__init__.cpython-36.pyc
GeMpy/__pycache__/geomodeller_xml_obj.cpython-36.pyc
GeMpy/geomodeller_xml_obj.py.bak
GeMpy/qgrid/__pycache__/
notebooks/prototype notebooks/Example_4_faults_network.ipynb
notebooks/prototype notebooks/Example_Peter_Model.ipynb
notebooks/prototype notebooks/Fabian.vtp
notebooks/prototype notebooks/Fabian1.vtp
notebooks/prototype notebooks/Fabian2.vtp
notebooks/prototype notebooks/Fabian3.vtp
notebooks/prototype notebooks/Fabian4.vtp
notebooks/prototype notebooks/FabianModelBigPoints.vtk
notebooks/prototype notebooks/FabianModelSmallPoints.vtk
notebooks/prototype notebooks/FabianModel_point.vti
notebooks/prototype notebooks/FabianModel_point_good_res.vti
notebooks/prototype notebooks/Fabian_f.vtp
notebooks/prototype notebooks/Fault.vtk
notebooks/prototype notebooks/Intrusions.ipynb
notebooks/prototype notebooks/Layer1.vtk
notebooks/prototype notebooks/Layer2.vtk
notebooks/prototype notebooks/Layer3.vtk
notebooks/prototype notebooks/Layer4.vtk
notebooks/prototype notebooks/More cave/
notebooks/prototype notebooks/PF_over_TKC/
notebooks/prototype notebooks/PerthBasin.vti
notebooks/prototype notebooks/PerthBasin.vtk
notebooks/prototype notebooks/PerthBasinOtherColors.vtk
notebooks/prototype notebooks/Physics.ipynb
notebooks/prototype notebooks/SandstoneSol.npy
notebooks/prototype notebooks/TriangleColoredPoints.vtp
notebooks/prototype notebooks/TriangleSolidColor.vtp
notebooks/prototype notebooks/Visualization3_vtkBasics.ipynb
notebooks/prototype notebooks/files fab/
notebooks/prototype notebooks/geomodels.sqlite
notebooks/prototype notebooks/legacy/.ipynb_checkpoints/
notebooks/prototype notebooks/models.npy
notebooks/prototype notebooks/olaqases.vox
notebooks/prototype notebooks/preth.npy
notebooks/prototype notebooks/sandstone.vtk
notebooks/prototype notebooks/sandstone.vtr
notebooks/prototype notebooks/simplices.npy
notebooks/prototype notebooks/vertices.npy
notebooks/prototype notebooks/voxet_sub.vox
notebooks/prototype notebooks/withfault.npy
gempy/addons/RexCloud_Api_key.txt
docs/source/Notebooks/Erosion.rst
docs/source/Notebooks/Example_1_Sandstone_files/Example_1_Sandstone_39_0.png
docs/source/Notebooks/Example_1_Sandstone_files/Example_1_Sandstone_41_0.png
Expand Down
12 changes: 4 additions & 8 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ dist: xenial
python:
- '3.7'

env: TRAVIS=true

install:
- pip install --upgrade setuptools pip
- pip install cython
Expand All @@ -16,18 +18,12 @@ install:
- pip install pyevtk
- pip install dataclasses emg3d pyvista panel discretize


script:

- pytest -v notebooks/integrations/ --nbval-lax --ignore-glob='*discret*'
- pytest -v notebooks/examples/ --nbval-lax --current-env --ignore-glob='*pography*' --ignore-glob='*lesmodel*' --ignore-glob=*Course*
- pytest -v notebooks/tutorials/ --nbval-lax --current-env --ignore-glob='ch1-6*' --ignore-glob='ch1-7*'
- pytest -v notebooks/examples/ --nbval-lax --current-env --ignore-glob='*pography*' --ignore-glob='*lesmodel*' --ignore-glob='*Course*'
- pytest -v notebooks/tutorials/ --nbval-lax --current-env --ignore-glob='*ch1-6*' --ignore-glob='ch1-7*' --ignore-glob='*ch1-10*' --ignore-glob='*MaskedMarchinCube_Onlap_relations*'
- pytest

sudo: required
cache: pip

#before_script: # configure a headless display to test plot generation
# - "export DISPLAY=:99.0"
# - "sh -e /etc/init.d/xvfb start"
# - sleep 3 # give xvfb some time to start
103 changes: 103 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# Contributing

We welcome and encoruage everyone to contribute to GemPy!
Contributions can be questions, bug reports, feature requests and new code.
Here is how to get started.

## Issues

### Questions

For questions about GemPy (e.g. its applications, functionality, and usage),
please [search the existing issues for related questions](https://github.com/cgre-aachen/gempy/issues).
If your question has not already been asked, then [make a new issue](https://github.com/cgre-aachen/gempy/issues/new/choose).

### Reporting Bugs

Please report bugs on the [issue page using the bug report template](https://github.com/cgre-aachen/gempy/issues/new?assignees=&labels=&template=bug_report.md&title=) and label the issue as a bug.
The template asks essential questions for you to answer so that we can to understand, reproduce, and fix the bug.
Be verbose!
Whenever possible, provide tracebacks and/or error messages, screenshots, and sample code or other files.

### Feature Requests

We encourage users to submit ideas for improvements to the GemPy project. For
this please create an issue on the
[issue page](https://github.com/cgre-aachen/gempy/issues) with the *Feature
Request* template and label. Please make sure to use a descriptive title and to
provide ample background information to help us implement that functionality
in the future.

## Contributing New Code

Any code contributions are welcome,
whether fixing a typo or bug,
adding new post-processing/plotting functionality,
improve core functionality,
or anything that you think should be in the repository.

Contributions should address an open issue (either a bug or a feature request).
If you have found a new bug
or have an idea or a new feature,
then please [open the issue](https://github.com/cgre-aachen/gempy/issues/new/choose)
for discussion and link to that issue in your pull request.

### Python code guidelines
We aim to follow particular Python coding guidelines to improve the sustainability and positive impact of this community project:

- Follow [The Zen of Python](https://www.python.org/dev/peps/pep-0020/), most importantly "readability counts" when writing Python code.
- Adhere to the [Style Guide for Python Code (PEP8)](https://www.python.org/dev/peps/pep-0008/).
- Write thorough and effective documentation:
Make a docstring for each module, function, class, and method,
all following [PEP 257](https://www.python.org/dev/peps/pep-0257/) for high-level guidelines
and [Google Python Style Guidelines](http://google.github.io/styleguide/pyguide.html) for Syntax.
**Example function documentation:**
```python
def func(arg1: int, arg2: float) -> int:
"""A concise one line summary of the function.
Additional information and description of the function, if necessary. This
can be as long and verbose as you think is necessary for other users and
developers to understand your functionality.
Args:
arg1 (int): Description of the first argument.
arg2 (float): Description of the second argument. Please use hanging
indentation for multi-line argument descriptions.
Returns:
(int) Description of the return value(s)
"""
return 42
```
- The code should explain the *what* and *how*. Add inline comments to explain the *why*.
If an inline comment seems to be needed, consider first making the code more readable.
For all comments, follow [PEP 8](https://www.python.org/dev/peps/pep-0008/).
- Test every line of code. Untested code is dead code.

### Licensing

All contributed code will be licensed under
[a LGPL-3 license](https://github.com/cgre-aachen/gempy/blob/master/LICENSE).
If you did not write the code yourself,
it is your responsibility to ensure that the existing license is compatible
and included in the contributed files.
In general we discourage contributing third party code.

### Testing

Our test suite uses [`pytest`](https://docs.pytest.org/).
You should be familiar with `pytest` before contributing.
Please run all tests locally before creating a pull request.
You can do this by running `pytest` via your terminal in your GemPy folder:
```bash
cd ./path/to/gempy
pytest
```
All tests are located in the `test` folder and its subfolders.
All contributed code must include test code in the pull request.

### Pull Requests

All contributions are made via pull requests (PR's) to the master branch.
You must complete the checklist in the [PR template](https://github.com/cgre-aachen/gempy/blob/master/.github/PULL_REQUEST_TEMPLATE.md) before we will review the PR and consider merging your contribution.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Check out the documentation either in [gempy.org](https://www.gempy.org/) (bette

<a name="feat"></a>


## Features

The core algorithm of *GemPy* is based on a universal cokriging interpolation method devised by
Expand Down
1 change: 1 addition & 0 deletions gempy/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
sys.path.append(os.path.normpath(os.path.join(SCRIPT_DIR, PACKAGE_PARENT)))

from .core.gempy_api import *
import gempy.plot.plot_api as _plot
import gempy.plot.plot as plot

assert sys.version_info[0] >= 3, "GemPy requires Python 3.X" # sys.version_info[1] for minor e.g. 6
Expand Down
Loading

0 comments on commit ac3de52

Please sign in to comment.