Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
6774c38
Refresh README
domfournier Mar 31, 2025
1a0a606
Bump python version for docs
domfournier Mar 31, 2025
09c41b7
Merge pull request #728 from MiraGeoscience/GEOPY-1163
domfournier Apr 1, 2025
a1dffa8
Remove beta from version
domfournier Apr 14, 2025
2e14027
Merge branch 'main' into release/0.12.0-dev.1
domfournier Apr 14, 2025
bc791a1
Update release notes.
domfournier Apr 14, 2025
f1a0b06
Add _param_class as class attribute to base
domfournier Apr 14, 2025
9c80259
Disable protected access
domfournier Apr 14, 2025
53b71df
UNpin version for docs
domfournier Apr 14, 2025
8d5a59b
Fix language warning to "en"
domfournier Apr 14, 2025
aeafcc1
Remove numbering on getting started
domfournier Apr 16, 2025
8c49f6c
Merge pull request #730 from MiraGeoscience/release/0.12.0-dev.1
domfournier Apr 16, 2025
c3d8204
go easy on pylint max-args as long as not too-many-positional-arguments
sebhmg Apr 17, 2025
ddf8a43
Merge branch 'main' into develop
sebhmg Aug 14, 2025
6c2cbc9
Merge remote-tracking branch 'upstream/main' into GEOPY-2384
sebhmg Aug 14, 2025
20b9dbf
Merge remote-tracking branch 'upstream/develop' into GEOPY-2384
sebhmg Aug 19, 2025
b378459
fix declarations of dependencies and relock conda env
sebhmg Aug 20, 2025
a378ce2
support also Python 3.11 and 3.12
sebhmg Aug 20, 2025
0532cd5
Fix imports
domfournier Aug 26, 2025
0ef94ff
Continue fiixing imports
domfournier Aug 27, 2025
bebec89
Multi fixes for inversion apps
domfournier Sep 8, 2025
63b8a25
Remove internal block_model app. FIx test
domfournier Sep 9, 2025
7186ff6
Bump versions according to GEOPY-2403
domfournier Sep 15, 2025
704e0d1
Use name of test for geoh5
domfournier Sep 15, 2025
bfdea17
Re-lock with release branches
domfournier Nov 26, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/python_analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ jobs:
uses: MiraGeoscience/CI-tools/.github/workflows/reusable-python-pytest.yml@main
with:
package-manager: 'conda'
python-versions: '["3.10"]'
python-versions: '["3.10", "3.11", "3.12"]'
os: '["ubuntu-latest", "windows-latest"]'
lfs: true
cache-number: 1
Expand Down
129 changes: 75 additions & 54 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,13 @@
:alt: pre-commit.ci status


Welcome to **geoapps** - Open-source applications in geosciences
================================================================
**Geoapps** - Open-source applications in geosciences
=====================================================

.. image:: https://github.com/MiraGeoscience/geoapps/raw/v0.10.0-rc.2/docs/images/index_page.png
:align: right
:width: 50%

In short
^^^^^^^^

The **geoapps** project has been created by `Mira Geoscience`_ for the development and sharing of open-source
applications in geoscience. Users will be able to directly leverage the powerful visualization capabilities of
Expand All @@ -44,12 +42,12 @@ applications in geoscience. Users will be able to directly leverage the powerful
.. _Geoscience ANALYST: https://mirageoscience.com/mining-industry-software/geoscience-analyst/


Links
^^^^^
Documentation
^^^^^^^^^^^^^

- `Download the latest stable version at <https://github.com/MiraGeoscience/geoapps/archive/main.zip>`_
- `Getting started <https://mirageoscience-geoapps.readthedocs-hosted.com/en/stable/content/installation.html#installation>`_
- `Documentation <https://mirageoscience-geoapps.readthedocs-hosted.com/en/stable/index.html>`_
- `Documentation <https://mirageoscience-geoapps.readthedocs-hosted.com>`_


Current sponsors
Expand All @@ -75,100 +73,109 @@ Install Conda

To install **geoapps**, you need to install **Conda** first.


We recommend to install **Conda** using `miniforge`_.

.. _miniforge: https://github.com/conda-forge/miniforge

Quick installation
-------------------

To install (or re-install) a conda environment to run **geoapps**, simply execute the **install.bat** file.

To install in editable mode, so that changes in the source code are immediately reflected in the
running application, execute with the ``-e`` option: ``install.bat -e``.

.. warning::

In editable mode, the source folder must not be moved or deleted after installation.

Within a conda environment
--------------------------

You can install (or update) a conda environment with all the requires packages to run **geoapps**.
To do so you can directly run the **Install_or_Update.bat** file by double left clicking on it.
Manual installation
-------------------

Install with conda
------------------
You should not install the package directly with ``pip``, as the app requires conda packages to run.

You can install the package using ``conda`` and the ``.lock`` files from a conda prompt:
First create a Conda environment with all the required dependencies,
then activate it and install the package in this environment using
``pip install --no-deps ...``

See instructions below for more details and options.

Prepare a Conda environment with dependencies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can create a Conda environment with all the required dependencies ``conda`` and the ``.lock``
files from a conda prompt::

$ conda env create --solver libmamba -n geoapps -f environments/[the_desired_env].lock.yml

.. note::

.. code-block:: bash
The package itself is not install yet in the Conda environment. See following instructions.

conda env create --solver libmamba -n my-env -f environments/[the_desired_env].lock.yml
.. warning::

Install with PyPI
-----------------
All the following ``pip`` commands are meant to be executed in the Conda environment you just created.
Activate it with::

You should not install the package from PyPI, as the app requires conda packages to run.
Still, you can install it in a prepared conda environment, telling ``pip`` not to install dependencies
thanks to the ``--no-deps`` option.
$ conda activate geoapps

From PyPI
~~~~~~~~~

To install the **geoapps** package published on PyPI:
To install the **geoapps** package published on PyPI::

.. code-block:: bash

pip install -U --no-deps geoapps
$ pip install --no-deps -U geoapps

From a Git tag or branch
~~~~~~~~~~~~~~~~~~~~~~~~
If the revision of the package is not on PyPI yet, you can install it from a Git tag:

.. code-block:: bash

pip install -U --no-deps --force-reinstall https://github.com/MiraGeoscience/geoapps/archive/refs/tags/TAG.zip
If the revision of the package is not on PyPI yet, you can install it from a Git tag::

Or to install the latest changes available on a given Git branch:
$ pip install --no-deps -U --force-reinstall https://github.com/MiraGeoscience/geoapps/archive/refs/tags/TAG.zip

.. code-block:: bash
Or to install the latest changes available on a given Git branch::

pip install -U --no-deps --force-reinstall https://github.com/MiraGeoscience/geoapps/archive/refs/heads/BRANCH.zip
$ pip install --no-deps -U --force-reinstall https://github.com/MiraGeoscience/geoapps/archive/refs/heads/BRANCH.zip

.. note::

The ``--force-reinstall`` option is used to make sure the updated version
of the sources is installed, and not the cached version, even if the version number
did not change. The ``-U`` or ``--upgrade`` option is used to make sure to get the latest version,
on not merely reinstall the same version. As the package is aimed to be in a **Conda environment**, the option ``--no-deps`` is used to avoid installing the dependencies with pip, as they will be installed with conda.
did not change.

The ``-U`` or ``--upgrade`` option is used to make sure to get the latest version,
on not merely reinstall the same version.

The option ``--no-deps`` is used to avoid installing the dependencies with pip,
as they have dependencies are already installed within the **Conda environment**.

From a local copy of the sources
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you have a git clone of the package sources locally,
you can install **geoapps** from the local copy of the sources with:
If you have a git clone of the package sources locally, you can install **geoapps** from the
local copy of the sources. At the root of the sources, you will find a ``pyproject.toml`` file.

Change directory to the root of the sources::

.. code-block:: bash
$ cd path/to/project_folder_with_pyproject_toml

pip install -U --force-reinstall path/to/project_folder_with_pyproject_toml
Then run::

Or in **editable mode**, so that you can edit the sources and see the effect immediately at runtime:
$ pip install --no-deps -U --force-reinstall .

.. code-block:: bash
Or in **editable mode**, so that you can edit the sources and see the effect immediately at runtime::

pip install -e -U --force-reinstall path/to/project_folder_with_pyproject_toml
$ pip install --no-deps -U --force-reinstall -e .

Setup for development
^^^^^^^^^^^^^^^^^^^^^
To configure the development environment and tools, please see `README-dev.rst`_.

.. _README-dev.rst: README-dev.rst

Third Party Software
^^^^^^^^^^^^^^^^^^^^
The geoapps Software may provide links to third party libraries or code (collectively "Third Party Software")
to implement various functions. Third Party Software does not comprise part of the Software.
The use of Third Party Software is governed by the terms of such software license(s).
Third Party Software notices and/or additional terms and conditions are located in the
`THIRD_PARTY_SOFTWARE.rst`_ file.

.. _THIRD_PARTY_SOFTWARE.rst: docs/THIRD_PARTY_SOFTWARE.rst

License
^^^^^^^
MIT License

Copyright (c) 2020-2025 Mira Geoscience

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
Expand All @@ -186,3 +193,17 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Third Party Software
^^^^^^^^^^^^^^^^^^^^
The geoapps Software may provide links to third party libraries or code (collectively "Third Party Software")
to implement various functions. Third Party Software does not comprise part of the Software.
The use of Third Party Software is governed by the terms of such software license(s).
Third Party Software notices and/or additional terms and conditions are located in the
`THIRD_PARTY_SOFTWARE.rst`_ file.

.. _THIRD_PARTY_SOFTWARE.rst: docs/THIRD_PARTY_SOFTWARE.rst

Copyright
^^^^^^^^^
Copyright (c) 2020-2025 Mira Geoscience Ltd.
2 changes: 2 additions & 0 deletions deps-lock-config.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
include_dev: True
py_versions:
- "3.10"
- "3.11"
- "3.12"
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en"
html_theme = "alabaster"

# otherwise, readthedocs.org uses their theme by default, so no need to specify it
Expand Down
6 changes: 0 additions & 6 deletions docs/content/installation.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,8 @@

Getting Started
===============

Whether you are a developer or an end-user, this page will help you get started with the **geoapps**.

.. contents::

.. sectnum::
:depth: 2

Installation
------------

Expand Down
14 changes: 14 additions & 0 deletions docs/content/release_notes.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
Release Notes
=============

Release 0.12.0 (2025-04-14)
---------------------------

Major release

- GEOPY-378: Allow balancing of octree mesh.
- GEOPY-440: Fix reference angles in MVI
- GEOPY-998: Migrate Peak Finder to **peak-finder-app** repository.
- GEOPY-1072: Implement line refinement for octree mesh.
- GEOPY-1224: Migrate inversion code to **simpeg-drivers** repository.
- GEOPY-1484: Migrate edge detection to **curve-apps** repository.
- General maintenance and bug fixes.


Release 0.11.1 (2024-03-04)
---------------------------

Expand Down
14 changes: 7 additions & 7 deletions docs/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@ name: geoapps-docs
channels:
- conda-forge
dependencies:
- python=3.8
- pip=21.0.1
- python=3.10
- pip
- ipywidgets
- ipykernel
- pandoc=3.1.3
- pandoc
- pip:
- numpydoc
- jinja2==3.0.3
- sphinx==3.5.4
- jinja2
- sphinx
- sphinx_issues
- nbsphinx
- sphinx-gallery==0.10
- sphinx-gallery
- jupyter_sphinx
- plotly==4.9.0
- plotly
3 changes: 3 additions & 0 deletions environments/env-python-3.11.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
dependencies:
- python=3.11.*
- pip
3 changes: 3 additions & 0 deletions environments/env-python-3.12.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
dependencies:
- python=3.12.*
- pip
Loading
Loading