|coverage| |maintainability| |precommit_ci| |style| |version| |status| |pyversions|
.. |docs| image:: https://readthedocs.org/projects/octree-creation-app/badge/
:alt: Documentation Status
:target: https://octree-creation-app.readthedocs.io/en/latest/?badge=latest
.. |coverage| image:: https://codecov.io/gh/MiraGeoscience/octree-creation-app/graph/badge.svg?token=8DzYB9EWdR
:alt: Code coverage
:target: https://codecov.io/gh/MiraGeoscience/octree-creation-app
.. |style| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:alt: Coding style
:target: https://github.com/pf/black
.. |version| image:: https://img.shields.io/pypi/v/octree-creation-app.svg
:alt: version on PyPI
:target: https://pypi.python.org/pypi/octree-creation-app/
.. |status| image:: https://img.shields.io/pypi/status/octree-creation-app.svg
:alt: version status on PyPI
:target: https://pypi.python.org/pypi/octree-creation-app/
.. |pyversions| image:: https://img.shields.io/pypi/pyversions/octree-creation-app.svg
:alt: Python versions
:target: https://pypi.python.org/pypi/octree-creation-app/
.. |precommit_ci| image:: https://results.pre-commit.ci/badge/github/MiraGeoscience/octree-creation-app/main.svg
:alt: pre-commit.ci status
:target: https://results.pre-commit.ci/latest/github/MiraGeoscience/octree-creation-app/main
.. |maintainability| image:: https://api.codeclimate.com/v1/badges/078c1e4de5e0bd8091c1/maintainability
:alt: Maintainability
:target: https://codeclimate.com/github/MiraGeoscience/octree-creation-app/maintainability
Octree Creation
===============
The **octree-creation-app** package lets users create Octree mesh objects with local refinements using the SimPEG.discretize package. The refinements can be performed on any number of ``Objects`` stored in a ``geoh5`` file.
.. contents:: Table of Contents
:local:
:depth: 3
Documentation
^^^^^^^^^^^^^
`Online documentation <https://mirageoscience-octree-creation-app.readthedocs-hosted.com/en/latest/>`_
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`_.
.. _miniforge: https://github.com/conda-forge/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:
.. code-block:: bash
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 **octree-creation-app** package published on PyPI:
.. code-block:: bash
pip install -U --no-deps octree-creation-app
From a Git tag or branch
~~~~~~~~~~~~~~~~~~~~~~~~
If the package is not on PiPY yet, you can install it from a Git tag:
.. code-block:: bash
pip install -U --no-deps --force-reinstall https://github.com/MiraGeoscience/octree-creation-app/archive/refs/tags/TAG.zip
Or to install the latest changes available on a given Git branch:
.. code-block:: bash
pip install -U --no-deps --force-reinstall https://github.com/MiraGeoscience/octree-creation-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. As the package is aimed to be in a **Conda environment**, the option ``--no-deps`` is used to avoid installing the dependencies with pip, as they will be installed with conda.
From 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:
.. code-block:: bash
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:
.. code-block:: bash
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`_.
.. _README-dev.rst: 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 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.
.. _THIRD_PARTY_SOFTWARE.rst: THIRD_PARTY_SOFTWARE.rst
Copyright
^^^^^^^^^
Copyright (c) 2023 Mira Geoscience Ltd.
Raw data
{
"_id": null,
"home_page": "https://www.mirageoscience.com/mining-industry-software/python-integration/",
"name": "octree-creation-app",
"maintainer": "Dominique Fournier",
"docs_url": null,
"requires_python": "<3.11,>=3.9",
"maintainer_email": "dominiquef@mirageoscience.com",
"keywords": null,
"author": "Mira Geoscience",
"author_email": "support@mirageoscience.com",
"download_url": "https://files.pythonhosted.org/packages/22/0e/bc0f966f0852fd8615b6b6f33b55c0021a77f164cfe067483189696945da/octree_creation_app-0.1.1.tar.gz",
"platform": null,
"description": "|coverage| |maintainability| |precommit_ci| |style| |version| |status| |pyversions|\n\n.. |docs| image:: https://readthedocs.org/projects/octree-creation-app/badge/\n :alt: Documentation Status\n :target: https://octree-creation-app.readthedocs.io/en/latest/?badge=latest\n\n.. |coverage| image:: https://codecov.io/gh/MiraGeoscience/octree-creation-app/graph/badge.svg?token=8DzYB9EWdR\n :alt: Code coverage\n :target: https://codecov.io/gh/MiraGeoscience/octree-creation-app\n\n.. |style| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :alt: Coding style\n :target: https://github.com/pf/black\n\n.. |version| image:: https://img.shields.io/pypi/v/octree-creation-app.svg\n :alt: version on PyPI\n :target: https://pypi.python.org/pypi/octree-creation-app/\n\n.. |status| image:: https://img.shields.io/pypi/status/octree-creation-app.svg\n :alt: version status on PyPI\n :target: https://pypi.python.org/pypi/octree-creation-app/\n\n.. |pyversions| image:: https://img.shields.io/pypi/pyversions/octree-creation-app.svg\n :alt: Python versions\n :target: https://pypi.python.org/pypi/octree-creation-app/\n\n.. |precommit_ci| image:: https://results.pre-commit.ci/badge/github/MiraGeoscience/octree-creation-app/main.svg\n :alt: pre-commit.ci status\n :target: https://results.pre-commit.ci/latest/github/MiraGeoscience/octree-creation-app/main\n\n.. |maintainability| image:: https://api.codeclimate.com/v1/badges/078c1e4de5e0bd8091c1/maintainability\n :alt: Maintainability\n :target: https://codeclimate.com/github/MiraGeoscience/octree-creation-app/maintainability\n\n\nOctree Creation\n===============\nThe **octree-creation-app** package lets users create Octree mesh objects with local refinements using the SimPEG.discretize package. The refinements can be performed on any number of ``Objects`` stored in a ``geoh5`` file.\n\n.. contents:: Table of Contents\n :local:\n :depth: 3\n\n\nDocumentation\n^^^^^^^^^^^^^\n`Online documentation <https://mirageoscience-octree-creation-app.readthedocs-hosted.com/en/latest/>`_\n\n\nInstallation\n^^^^^^^^^^^^\n**octree-creation-app** is currently written for Python 3.10 or higher.\n\nInstall Conda\n-------------\n\nTo install **octree-creation-app**, you need to install **Conda** first.\n\nWe recommend to install **Conda** using `miniforge`_.\n\n.. _miniforge: https://github.com/conda-forge/miniforge\n\nWithin a conda environment\n--------------------------\n\nYou can install (or update) a conda environment with all the requires packages to run **octree-creation-app**.\nTo do so you can directly run the **Install_or_Update.bat** file by double left clicking on it.\n\nInstall with conda\n------------------\n\nYou can install the package using ``conda`` and the ``.lock`` files from a conda prompt:\n\n.. code-block:: bash\n\n conda env create -n my-env -f environments/[the_desired_env].lock.yml\n\nInstall with PyPI\n-----------------\n\nYou should not install the package from PyPI, as the app requires conda packages to run.\nStill, you can install it in a conda environment without its dependencies (``--no-deps``).\n\nFrom PyPI\n~~~~~~~~~\n\nTo install the **octree-creation-app** package published on PyPI:\n\n.. code-block:: bash\n\n pip install -U --no-deps octree-creation-app\n\nFrom a Git tag or branch\n~~~~~~~~~~~~~~~~~~~~~~~~\nIf the package is not on PiPY yet, you can install it from a Git tag:\n\n.. code-block:: bash\n\n pip install -U --no-deps --force-reinstall https://github.com/MiraGeoscience/octree-creation-app/archive/refs/tags/TAG.zip\n\nOr to install the latest changes available on a given Git branch:\n\n.. code-block:: bash\n\n pip install -U --no-deps --force-reinstall https://github.com/MiraGeoscience/octree-creation-app/archive/refs/heads/BRANCH.zip\n\n.. note::\n The ``--force-reinstall`` option is used to make sure the updated version\n of the sources is installed, and not the cached version, even if the version number\n did not change. The ``-U`` or ``--upgrade`` option is used to make sure to get the latest version,\n on not merely reinstall the same version. As the package is aimed to be in a **Conda environment**, the option ``--no-deps`` is used to avoid installing the dependencies with pip, as they will be installed with conda.\n\nFrom a local copy of the sources\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nIf you have a git clone of the package sources locally,\nyou can install **octree-creation-app** from the local copy of the sources with:\n\n.. code-block:: bash\n\n pip install -U --force-reinstall path/to/project_folder_with_pyproject_toml\n\nOr in **editable mode**, so that you can edit the sources and see the effect immediately at runtime:\n\n.. code-block:: bash\n\n pip install -e -U --force-reinstall path/to/project_folder_with_pyproject_toml\n\nSetup for development\n^^^^^^^^^^^^^^^^^^^^^\nTo configure the development environment and tools, please see `README-dev.rst`_.\n\n.. _README-dev.rst: README-dev.rst\n\nLicense\n^^^^^^^\nMIT License\n\nCopyright (c) 2024 Mira Geoscience\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n\nThird Party Software\n^^^^^^^^^^^^^^^^^^^^\nThe octree-creation-app Software may provide links to third party libraries or code (collectively \u201cThird Party Software\u201d)\nto implement various functions. Third Party Software does not comprise part of the Software.\nThe use of Third Party Software is governed by the terms of such software license(s).\nThird Party Software notices and/or additional terms and conditions are located in the\n`THIRD_PARTY_SOFTWARE.rst`_ file.\n\n.. _THIRD_PARTY_SOFTWARE.rst: THIRD_PARTY_SOFTWARE.rst\n\nCopyright\n^^^^^^^^^\nCopyright (c) 2023 Mira Geoscience Ltd.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Octree creation app.",
"version": "0.1.1",
"project_urls": {
"Documentation": "https://mirageoscience-octree-creation-app.readthedocs-hosted.com/",
"Homepage": "https://www.mirageoscience.com/mining-industry-software/python-integration/",
"Repository": "https://github.com/MiraGeoscience/octree-creation-app"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "15914edade49a54b21efe43e6a8c39adae37f651efde088d8d678cef2507b7f8",
"md5": "0982261da3e8088643c389bb35f3f2c2",
"sha256": "0a3c93b029e63df520b91d3aca29a40f7839cb8a152bf99e87b177573198a15f"
},
"downloads": -1,
"filename": "octree_creation_app-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0982261da3e8088643c389bb35f3f2c2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.11,>=3.9",
"size": 21675,
"upload_time": "2024-06-17T23:49:05",
"upload_time_iso_8601": "2024-06-17T23:49:05.536054Z",
"url": "https://files.pythonhosted.org/packages/15/91/4edade49a54b21efe43e6a8c39adae37f651efde088d8d678cef2507b7f8/octree_creation_app-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "220ebc0f966f0852fd8615b6b6f33b55c0021a77f164cfe067483189696945da",
"md5": "5cab36d46956f436ea9c47aceef5898c",
"sha256": "8b2d4754aca64f51c0c41010abcb6352e54d2c4515211b99ad9d47b83209cfb4"
},
"downloads": -1,
"filename": "octree_creation_app-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "5cab36d46956f436ea9c47aceef5898c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.11,>=3.9",
"size": 16019,
"upload_time": "2024-06-17T23:49:11",
"upload_time_iso_8601": "2024-06-17T23:49:11.534694Z",
"url": "https://files.pythonhosted.org/packages/22/0e/bc0f966f0852fd8615b6b6f33b55c0021a77f164cfe067483189696945da/octree_creation_app-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-17 23:49:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MiraGeoscience",
"github_project": "octree-creation-app",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "octree-creation-app"
}
JSON
