Geoapps Utils
Project description
geoapps-utils
The geoapps-utils package provides utility functions used by geoapps.
Installation
geoapps-utils is currently written for Python 3.10 or higher.
Install Conda
To install geoapps-utils, 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 geoapps-utils. 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.ymlInstall 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 geoapps-utils package published on PyPI:
pip install -U --no-deps geoapps-utilsFrom 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/geoapps-utils/archive/refs/tags/TAG.zipOr to install the latest changes available on a given Git branch:
pip install -U --no-deps --force-reinstall https://github.com/MiraGeoscience/geoapps-utils/archive/refs/heads/BRANCH.zipFrom a local copy of the sources
If you have a git clone of the package sources locally, you can install geoapps-utils from the local copy of the sources with:
pip install -U --force-reinstall path/to/project_folder_with_pyproject_tomlOr 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_tomlSetup for development
To configure the development environment and tools, please see README-dev.rst.
Third Party Software
The geoapps-utils package 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.
License
MIT License
Copyright (c) 2023 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.
Copyright
Copyright (c) 2023 Mira Geoscience Ltd.
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 geoapps_utils-0.2.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3db78986bb4ca66d081ade9af91ffb397bf079a5abdbce694f17c3e01080f821 |
|
| MD5 | 05c3d20dae55351c3a0dcbbc9975f23f |
|
| BLAKE2b-256 | 6eb61c7703855b6aa8100d54d72fd119d9b5a8fa1da235c7ac0cbd041958550d |
