Package: octree-creation-app
Octree CreationTheoctree-creation-apppackage lets users create Octree mesh objects with local refinements using the SimPEG.discretize package. The refinements can be performed on any number ofObjectsstored in ageoh5file.Table of ContentsInstallationInstall CondaWithin a conda environmentInstall with condaInstall with PyPIFrom PyPIFrom a Git tag or branchFrom a local copy of the sourcesSetup for developmentLicenseThird Party SoftwareCopyrightInstallationoctree-creation-appis currently written for Python 3.10 or higher.Install CondaTo installoctree-creation-app, you need to installCondafirst.We recommend to installCondausingminiforge.Within a conda environmentYou can install (or update) a conda environment with all the requires packages to runoctree-creation-app.
To do so you can directly run theInstall_or_Update.batfile by double left clicking on it.Install with condaYou can install the package usingcondaand the.lockfiles from a conda prompt:condaenvcreate-nmy-env-fenvironments/[the_desired_env].lock.ymlInstall with PyPIYou 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 PyPITo install theoctree-creation-apppackage published on PyPI:pipinstall-U--no-depsoctree-creation-appFrom a Git tag or branchIf the package is not on PiPY yet, you can install it from a Git tag:pipinstall-U--no-deps--force-reinstallhttps://github.com/MiraGeoscience/octree-creation-app/archive/refs/tags/TAG.zipOr to install the latest changes available on a given Git branch:pipinstall-U--no-deps--force-reinstallhttps://github.com/MiraGeoscience/octree-creation-app/archive/refs/heads/BRANCH.zipNoteThe--force-reinstalloption 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-Uor--upgradeoption 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 aConda environment, the option--no-depsis used to avoid installing the dependencies with pip, as they will be installed with conda.From a local copy of the sourcesIf you have a git clone of the package sources locally,
you can installoctree-creation-appfrom the local copy of the sources with:pipinstall-U--force-reinstallpath/to/project_folder_with_pyproject_tomlOr ineditable mode, so that you can edit the sources and see the effect immediately at runtime:pipinstall-e-U--force-reinstallpath/to/project_folder_with_pyproject_tomlSetup for developmentTo configure the development environment and tools, please seeREADME-dev.rst.LicenseMIT LicenseCopyright (c) 2024 Mira GeosciencePermission 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 SoftwareThe 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 theTHIRD_PARTY_SOFTWARE.rstfile.CopyrightCopyright (c) 2023 Mira Geoscience Ltd.