Skip to content

Commit bf77729

Browse files
committed
Update docs from build -1
0 parents  commit bf77729

426 files changed

Lines changed: 303697 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.env.example

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
LIQUID_EARTH_API_TOKEN = "foobar-1499cbe49808c8cfef14303d2aaacXDx-w1vc1bD065Wj0ABi3HD2fzQ"
2+
BOREHOLES_SOUTH_FOLDER = "/mnt/d/OneDrive - .../boreholes_south"

.github/FUNDING.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# These are supported funding model platforms
2+
3+
github: Leguark
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is. Include error messages /
12+
tracebacks. If useful include screenshots.
13+
14+
**To Reproduce**
15+
Provide detailed steps to reproduce the behavior:
16+
17+
1.
18+
2.
19+
3.
20+
...
21+
22+
**Expected behavior**
23+
A clear and concise description of what you expected to happen.
24+
25+
**Screenshots**
26+
If applicable, add screenshots to help explain your problem.
27+
28+
**Desktop (please complete the following information):**
29+
* OS: (e.g. iOS)
30+
* GemPy Version
31+
* if installed via pip: provide GemPy version (e.g. 2.0.1)
32+
* if cloned from GitHub: provide Git commit id (e.g. 839bf85f)
33+
* Jupyter Version (if applicable)
34+
35+
**Additional context**
36+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/question.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Question
3+
about: Ask a question about GemPy
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**What is your question?**

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Description
2+
Please include a summary of the changes.
3+
4+
Relates to <issue>
5+
6+
# Checklist
7+
- [ ] My code uses type hinting for function and method arguments and return values.
8+
- [ ] I have created tests which cover my code.
9+
- [ ] The test code either 1. demonstrates at least one valuable use case (e.g. integration tests)
10+
or 2. verifies that outputs are as expected for given inputs (e.g. unit tests).
11+
- [ ] New tests pass locally with my changes.
12+

.gitignore

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
.vscode
2+
.idea
3+
.DS_Store
4+
.vs
5+
.cache/
6+
GeMpy/__pycache__/__init__.cpython-36.pyc
7+
GeMpy/__pycache__/geomodeller_xml_obj.cpython-36.pyc
8+
GeMpy/geomodeller_xml_obj.py.bak
9+
GeMpy/qgrid/__pycache__/
10+
../gempy_plugins/gempy_plugins/addons/RexCloud_Api_key.txt
11+
docs/source/Notebooks/Erosion.rst
12+
docs/source/Notebooks/Example_1_Sandstone_files/Example_1_Sandstone_39_0.png
13+
docs/source/Notebooks/Example_1_Sandstone_files/Example_1_Sandstone_41_0.png
14+
docs/source/Notebooks/Example_1_Sandstone_files/Example_1_Sandstone_46_1.png
15+
docs/source/Notebooks/Example_2_Simple_PyMC3_files/
16+
docs/source/Notebooks/Example_3_Faults_files/
17+
docs/source/Notebooks/OptimizationNotebook.rst
18+
docs/source/Notebooks/legacy/
19+
docs/source/index_legacy.rst
20+
input_data/Erosion_Foliations.csv
21+
input_data/Erosion_Points.csv
22+
input_data/FabLessPoints_Foliations.csv
23+
input_data/FabLessPoints_Points.csv
24+
input_data/Fab_Model_MorePoints_Foliations.csv
25+
input_data/Fab_Model_MorePoints_Points.csv
26+
input_data/Intrusion-test/
27+
legacy/.ipynb_checkpoints/
28+
test/.ipynb_checkpoints/
29+
30+
test/__pycache__/
31+
test/legacy/
32+
test/log
33+
test/log2
34+
/legacy/geomodeller_xml_obj.py.bak
35+
!/notebooks/input_data/FabLessPoints_Foliations.csv
36+
!/notebooks/input_data/FabLessPoints_Points.csv
37+
38+
### Python template
39+
# Byte-compiled / optimized / DLL files
40+
__pycache__/
41+
*.py[cod]
42+
*$py.class
43+
44+
# C extensions
45+
*.so
46+
47+
# Distribution / packaging
48+
.Python
49+
env/
50+
51+
develop-eggs/
52+
dist/
53+
downloads/
54+
eggs/
55+
.eggs/
56+
lib/
57+
lib64/
58+
parts/
59+
sdist/
60+
var/
61+
wheels/
62+
*.egg-info/
63+
.installed.cfg
64+
*.egg
65+
66+
# PyInstaller
67+
# Usually these files are written by a python script from a template
68+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
69+
*.manifest
70+
*.spec
71+
72+
# Installer logs
73+
pip-log.txt
74+
pip-delete-this-directory.txt
75+
76+
# Unit test / coverage reports
77+
htmlcov/
78+
.tox/
79+
.coverage
80+
.coverage.*
81+
.cache
82+
nosetests.xml
83+
coverage.xml
84+
*,cover
85+
.hypothesis/
86+
87+
# Translations
88+
*.mo
89+
*.pot
90+
91+
# Django stuff:
92+
*.log
93+
local_settings.py
94+
95+
# Flask stuff:
96+
instance/
97+
.webassets-cache
98+
99+
# Scrapy stuff:
100+
.scrapy
101+
102+
103+
104+
# PyBuilder
105+
target/
106+
107+
# Jupyter Notebook
108+
.ipynb_checkpoints
109+
110+
# pyenv
111+
.python-version
112+
113+
# celery beat schedule file
114+
celerybeat-schedule
115+
116+
# SageMath parsed files
117+
*.sage.py
118+
119+
# dotenv
120+
.env
121+
122+
# virtualenv
123+
.venv
124+
venv/
125+
ENV/
126+
127+
# Spyder project settings
128+
.spyderproject
129+
130+
# Rope project settings
131+
.ropeproject
132+
133+
notebooks/prototype notebooks/vtks
134+
notebooks/prototype notebooks/vtk_res_model_adjusted_1
135+
notebooks/prototype notebooks/vtk_exp_smooth_trnasitions
136+
notebooks/prototype notebooks/plots
137+
138+
# Remove the built document files - but not the static ones, which are required for the builds
139+
docs/build
140+
# The following files are generated locally during sphinx updates - they don't have to be part of the repo
141+
docs/source/examples
142+
docs/source/tutorials
143+
docs/source/Modeling\ Classes
144+
docs/source/GemPy\ API
145+
docs/source/Helper\ Classes
146+
docs/source/Plot
147+
docs/source/external
148+
docs/source/sg_execution_times.rst
149+
test/figs
150+
151+
Profiles
152+
examples/data/input_data/Claudius/Results_
153+
154+
/docs/source/gen_modules/
155+
156+
#examples folders
157+
examples/integrations/*.vs
158+
examples/integrations/*.ugi
159+
examples/integrations/*.h5
160+
examples/integrations/*.xmf
161+
examples/integrations/*.ss
162+
examples/integrations/*.out
163+
164+
# Approval tests
165+
*.received.txt
166+
*.Identifier
167+
/.obsidian/app.json
168+
/.obsidian/appearance.json
169+
/.obsidian/core-plugins.json
170+
/.obsidian/core-plugins-migration.json
171+
/.obsidian/hotkeys.json
172+
/.obsidian/workspace.json
173+
174+
# Ignore generated tutorial files
175+
examples/tutorials/z_other_tutorials/json_io/04_simple_layer_stack.py
176+
examples/tutorials/z_other_tutorials/json_io/fault_scalar_field.png
177+
examples/tutorials/z_other_tutorials/json_io/initial_model_y.png
178+
examples/tutorials/z_other_tutorials/json_io/model_with_data.png
179+
examples/tutorials/z_other_tutorials/json_io/multiple_series_faults_computed.json
180+
181+
# Generated JSON files from examples
182+
examples/tutorials/z_other_tutorials/json_io/combination_model.json
183+
examples/tutorials/z_other_tutorials/json_io/combination_model_computed.json

.travis.yml

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
language: python
2+
os: linux
3+
dist: xenial
4+
5+
branches:
6+
only:
7+
- master
8+
- release
9+
10+
python:
11+
- '3.8'
12+
13+
before_install:
14+
# configure a headless display
15+
- git clone --depth 1 git://github.com/pyvista/gl-ci-helpers.git
16+
- source ./gl-ci-helpers/travis/setup_headless_display.sh
17+
18+
install:
19+
- sudo apt-get update
20+
# We do this conditionally because it saves us some downloading if the
21+
# version is the same.
22+
- wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh;
23+
- bash miniconda.sh -b -p $HOME/miniconda
24+
- export PATH="$HOME/miniconda/bin:$PATH"
25+
- hash -r
26+
- conda config --set always_yes yes --set changeps1 no
27+
- conda update --all
28+
# Useful for debugging any issues with conda
29+
- conda info -a
30+
31+
# Install and activate environment, install packages
32+
- conda create -q -n tenv python=$TRAVIS_PYTHON_VERSION
33+
- source activate tenv
34+
35+
# Installs from conda-forge
36+
- conda install -c conda-forge python-graphviz
37+
- conda install -c conda-forge pip matplotlib ipython six pytest pytest-cov ipywidgets
38+
- conda install -c conda-forge recommonmark networkx panel setuptools mkl-service
39+
40+
# Installs from anaconda
41+
- conda install -c anaconda libffi
42+
43+
- conda install aesara
44+
45+
# Installs from pip
46+
- pip install welly pymc3
47+
48+
- pip install scikit-image>=0.17 sklearn
49+
50+
- pip install pandas seaborn>=0.9 sphinx-gallery
51+
# Install
52+
- pip install -e .
53+
54+
# Pyvista should have been fixed- pip install pyvista
55+
# Arviz broke with xarray update
56+
- pip install git+https://github.com/arviz-devs/arviz --force-reinstall
57+
58+
# Install subsurface
59+
- pip install subsurface
60+
61+
- conda install -c conda-forge gdal
62+
63+
- python -c "import pyvista as pv;print(pv.Report())"
64+
65+
- pip install pooch
66+
67+
stages:
68+
- test
69+
70+
jobs:
71+
include:
72+
- stage: test
73+
script:
74+
- pytest -v
75+
cache: pip

AUTHORS.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
.. _authors_ref:
2+
3+
Authors
4+
-------
5+
6+
.. image:: https://img.shields.io/github/contributors/gempy-project/gempy_engine.svg?logo=github&logoColor=white
7+
:target: https://github.com/gempy-projects/gempy_engine/graphs/contributors/
8+
9+
10+
The following is a list of authors who have made substantial contributions to
11+
the conception or design of this software; or the creation of new code used in
12+
this software; or have drafted the work or substantively revised it:
13+
14+
- Miguel de la Varga, (`@leguark <https://github.com/leguark/>`_)
15+
- Alexander Zimmerman
16+
- Elisa Heim
17+
- Alexander Schaaf
18+
- Fabian Stamm
19+
- Florian Wellmann

CITATION.cff

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
cff-version: 1.2.0
2+
message: "If you use GemPy, please cite it as below."
3+
authors:
4+
- family-names: "de la Varga"
5+
given-names: "Miguel"
6+
orcid: https://orcid.org/0000-0001-6941-2685
7+
- family-names: "Schaaf"
8+
given-names: "Alexander"
9+
- family-names: "Wellmann"
10+
given-names: "Florian"
11+
orcid: https://orcid.org/0000-0003-2552-1876
12+
title: "GemPy 1.0: open-source stochastic geological modeling and inversion"
13+
version: 1.0
14+
doi: https://doi.org/10.5194/gmd-12-1-2019
15+
date-released: 2019-01-02
16+
url: "https://github.com/cgre-aachen/gempy"

0 commit comments

Comments
 (0)