peak-finder-app 0.1.0

Peak Finder App

Peak-Finder-App

peak-finder-app is a package for the detection and grouping of time-domain electromagnetic (TEM) anomalies measured along flight lines.

Documentation

Online documentation

Installation

peak-finder-app is currently written for Python 3.10 or higher.

Install Conda

To install peak-finder-app, you need to install Conda first.

We recommend to install Conda using miniforge.

Quick installation

To install (or re-install) a conda environment to run peak-finder-app, 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 (in editable mode, the source folder must not be moved or deleted after installation).

Manual installation

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

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 my-env -f environments/[the_desired_env].lock.yml

Note

The package itself is not install yet in the Conda environment. See following instructions.

Warning

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

$ conda activate my-env

From PyPI

To install the peak-finder-app package published on PyPI:

$ pip install --no-deps -U peak-finder-app

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:

$ pip install --no-deps -U --force-reinstall https://github.com/MiraGeoscience/peak-finder-app/archive/refs/tags/TAG.zip

Or to install the latest changes available on a given Git branch:

$ pip install --no-deps -U --force-reinstall https://github.com/MiraGeoscience/peak-finder-app/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.

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 peak-finder-app 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:

$ cd path/to/project_folder_with_pyproject_toml

Then run:

$ pip install --no-deps -U --force-reinstall .

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 -e .

Setup for development

To configure the development environment and tools, please see README-dev.rst.

License

MIT License

Copyright (c) 2024 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 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 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 peak-finder-app 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.

Copyright

Copyright (c) 2024 Mira Geoscience Ltd.