Octree creation app.
Project description
Octree Creation
The octree-creation-app library lets the user create an octree mesh object with local refinement based on Objects stored in a geoh5 file.
Documentation
Installation
octree-creation-app is currently written for Python 3.10 or higher.
Install Conda
To install octree-creation-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 octree-creation-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.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 octree-creation-app package published on PyPI:
pip install -U --no-deps octree-creation-appFrom 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/octree-creation-app/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/octree-creation-app/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 octree-creation-app 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.
License
# TODO: ADD LICENSE TERMS
Third Party Software
The octree-creation-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) 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 octree_creation_app-0.1.0a1.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0568899ff549e8e1ed585183a332277e1675aca95886edbeb1d8555136007420 |
|
| MD5 | c040e0a9569ffa47fe14a6fedcdeb7d0 |
|
| BLAKE2b-256 | aa5e94ced5ccc5fd68afd0aa3b41aad04a281bbb29f46a7945b6922fe9d8a58a |
Hashes for octree_creation_app-0.1.0a1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 18ce23ae376c4133e6ace09cbdf96ecff2e1f3f0d5b9de35f13aac485b05de7e |
|
| MD5 | 72f66e83510894f5db941a238bf8b797 |
|
| BLAKE2b-256 | 0dff0a04f1125361507c3982723c0bcd06f02c094027d4cc5692c7fe98463675 |
