Skip to content

Commit e5bc756

Browse files
domfournierdomfournier
authored
Merge pull request #29 from MiraGeoscience/GEOPY-2157
GEOPY-2157: Migrate octree-creation-app to grid-app
2 parents a54f9dd + 028ff62 commit e5bc756

54 files changed

Lines changed: 3249 additions & 85 deletions

Some content is hidden

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

‎.readthedocs.yml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
version: 2
2+
3+
# Set the version of Python and other tools you might need
4+
build:
5+
os: "ubuntu-22.04"
6+
tools:
7+
python: "mambaforge-22.9"
8+
9+
# Build documentation in the docs/ directory with Sphinx
10+
sphinx:
11+
configuration: docs/source/conf.py
12+
13+
conda:
14+
environment: docs/environment.yml
15+
16+
python:
17+
install:
18+
- method: pip
19+
path: .

‎.rstcheck.cfg‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
[rstcheck]
2-
ignore_directives=automodule,include
2+
ignore_directives=automodule,automethod,include
33
report_level=WARNING
4+
ignore_substitutions = copyright_notice

‎docs/environment.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: geoh5py_docs
2+
3+
channels:
4+
- conda-forge
5+
- defaults
6+
dependencies:
7+
- python=3.10
8+
- matplotlib
9+
- scipy
10+
- h5py
11+
- pip
12+
- ipykernel
13+
- pip:
14+
- sphinx
15+
- sphinx_issues
16+
- sphinx_rtd_theme
17+
- sphinxcontrib-bibtex
18+
- nbsphinx
19+
- nbstripout
20+
- numpydoc
21+
- jupyter_client

‎docs/make.bat‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
%SPHINXBUILD% >NUL 2>NUL
14+
if errorlevel 9009 (
15+
echo.
16+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
17+
echo.installed, then set the SPHINXBUILD environment variable to point
18+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
19+
echo.may add the Sphinx directory to PATH.
20+
echo.
21+
echo.If you don't have Sphinx installed, grab it from
22+
echo.https://www.sphinx-doc.org/
23+
exit /b 1
24+
)
25+
26+
if "%1" == "" goto help
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎docs/source/THIRD_PARTY_SOFTWARE.rst‎

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,28 @@
1-
The grid-apps repository and source distributions bundle several libraries that are
1+
Third Party Software
2+
====================
3+
4+
The octree-creation-app repository and source distributions bundle several libraries that are
25
compatibly licensed. We list these here.
36

47
.. list-table::
5-
:widths: 30 30 60
6-
:header-rows: 1
8+
:widths: 30 30 60
9+
:header-rows: 1
710

8-
* - Name
9-
- License
10-
- Description
11-
* - `discretize <https://discretize.simpeg.xyz/>`_
12-
- MIT
13-
- Discretization tools for finite volume and inverse problems
14-
* - `geoh5py <https://github.com/MiraGeoscience/geoh5py>`_
15-
- LGPL-3.0-or-later
16-
- Python API for geoh5, an open file format for geoscientific data
17-
* - `geoapps-utils <https://github.com/MiraGeoscience/geoapps-utils>`_
18-
- MIT
19-
- Utilities for geoscientific applications.
20-
* - `numpy <https://github.com/numpy/numpy>`_
21-
- BSD-3-Clause
22-
- Fundamental package for array computing in Python
23-
* - `scipy <https://github.com/scipy/scipy>`_
24-
- BSD-3-Clause
25-
- Fundamental algorithms for scientific computing in Python
11+
* - Name
12+
- License
13+
- Description
14+
* - `discretize <https://simpeg.xyz/>`_
15+
- MIT
16+
- Discretization tools for finite volume and inverse problems
17+
* - `geoh5py <https://github.com/MiraGeoscience/geoh5py>`_
18+
- LGPL-3.0-or-later
19+
- Python API for geoh5, an open file format for geoscientific data
20+
* - `geoapps-utils <https://github.com/MiraGeoscience/geoapps-utils>`_
21+
- MIT
22+
- Utilities for geoscientific applications.
23+
* - `numpy <https://github.com/numpy/numpy>`_
24+
- BSD-3-Clause
25+
- Fundamental package for array computing in Python
26+
* - `scipy <https://github.com/scipy/scipy>`_
27+
- BSD-3-Clause
28+
- Fundamental algorithms for scientific computing in Python

‎docs/source/api/grid_apps.block_model_to_octree.rst‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
grid\_apps.block\_model\_to\_octree package
2+
===========================================
3+
4+
Submodules
5+
----------
6+
7+
grid\_apps.block\_model\_to\_octree.driver module
8+
-------------------------------------------------
9+
10+
.. automodule:: grid_apps.block_model_to_octree.driver
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
grid\_apps.block\_model\_to\_octree.options module
16+
--------------------------------------------------
17+
18+
.. automodule:: grid_apps.block_model_to_octree.options
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
Module contents
24+
---------------
25+
26+
.. automodule:: grid_apps.block_model_to_octree
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:

‎docs/source/api/grid_apps.block_models.rst‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
grid\_apps.block\_models package
2+
================================
3+
4+
Submodules
5+
----------
6+
7+
grid\_apps.block\_models.driver module
8+
--------------------------------------
9+
10+
.. automodule:: grid_apps.block_models.driver
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
grid\_apps.block\_models.options module
16+
---------------------------------------
17+
18+
.. automodule:: grid_apps.block_models.options
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
Module contents
24+
---------------
25+
26+
.. automodule:: grid_apps.block_models
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:

‎docs/source/api/grid_apps.octree_creation.rst‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
grid\_apps.octree\_creation package
2+
===================================
3+
4+
Submodules
5+
----------
6+
7+
grid\_apps.octree\_creation.driver module
8+
-----------------------------------------
9+
10+
.. automodule:: grid_apps.octree_creation.driver
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
grid\_apps.octree\_creation.options module
16+
------------------------------------------
17+
18+
.. automodule:: grid_apps.octree_creation.options
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
Module contents
24+
---------------
25+
26+
.. automodule:: grid_apps.octree_creation
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:

‎docs/source/api/grid_apps.rst‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
API Reference
2+
=============
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
grid_apps.block_model_to_octree
11+
grid_apps.block_models
12+
grid_apps.octree_creation
13+
14+
Submodules
15+
----------
16+
17+
grid\_apps.driver module
18+
------------------------
19+
20+
.. automodule:: grid_apps.driver
21+
:members:
22+
:undoc-members:
23+
:show-inheritance:
24+
25+
grid\_apps.utils module
26+
-----------------------
27+
28+
.. automodule:: grid_apps.utils
29+
:members:
30+
:undoc-members:
31+
:show-inheritance:
32+
33+
Module contents
34+
---------------
35+
36+
.. automodule:: grid_apps
37+
:members:
38+
:undoc-members:
39+
:show-inheritance:

‎docs/source/applications.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Applications
2+
============
3+
4+
The ``Grid Apps`` package provides several modules for creating and manipulating grid objects, specifically octree meshes and block models, which can be used in geophysical modeling and visualization.
5+
6+
.. toctree::
7+
:maxdepth: 2
8+
9+
octree_creation
10+
block_model_to_octree
11+
block_model

0 commit comments

Comments
 (0)