Peak Finder App
Project description
peak-finder-app: # TODO: SHORT DESCRIPTION
peak-finder-app is a package for the detection and grouping of time-domain electromagnetic (TEM) anomalies measured along flight lines.
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.
Within a conda environment
You can install (or update) a conda environment with all the requires packages to run peak-finder-app. To do so you can directly run the Install_or_Update.bat file by double left clicking on it.
Install with conda
You can install the package using conda and the .lock files from a conda prompt:
conda env create -n my-env -f environments/[the_desired_env].lock.yml
Install with PyPI
You should not install the package from PyPI, as the app requires conda packages to run. Still, you can install it in a conda environment without its dependencies (--no-deps).
From PyPI
To install the peak-finder-app package published on PyPI:
pip install -U --no-deps peak-finder-app
From a Git tag or branch
If the package is not on PiPY yet, you can install it from a Git tag:
pip install -U --no-deps --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 -U --no-deps --force-reinstall https://github.com/MiraGeoscience/peak-finder-app/archive/refs/heads/BRANCH.zip
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 with:
pip install -U --force-reinstall path/to/project_folder_with_pyproject_toml
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
Setup for development
To configure the development environment and tools, please see README-dev.rst.
License
# TODO: ADD LICENSE TERMS
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for peak_finder_app-0.1.0a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c0dfcb405052f5b09221b5158da46ac2b4e593f0327a0cdc2910ed355189f22 |
|
MD5 | 03b6df0ce8c66eabaca114464a0688db |
|
BLAKE2b-256 | 41b8acc69a58c74086f77d88c8848d06d0c81de3c182731bdea04d1081cc431a |