|coverage| |maintainability| |precommit_ci| |docs| |style| |version| |status| |pyversions|
.. |docs| image:: https://readthedocs.com/projects/mirageoscience-las-geoh5/badge/?version=latest
:alt: Documentation Status
:target: https://mirageoscience-las-geoh5.readthedocs-hosted.com/en/latest/?badge=latest
.. |coverage| image:: https://codecov.io/gh/MiraGeoscience/las-geoh5/branch/develop/graph/badge.svg
:alt: Code coverage
:target: https://codecov.io/gh/MiraGeoscience/las-geoh5
.. |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/las-geoh5.svg
:alt: version on PyPI
:target: https://pypi.python.org/pypi/las-geoh5/
.. |status| image:: https://img.shields.io/pypi/status/las-geoh5.svg
:alt: version status on PyPI
:target: https://pypi.python.org/pypi/las-geoh5/
.. |pyversions| image:: https://img.shields.io/pypi/pyversions/las-geoh5.svg
:alt: Python versions
:target: https://pypi.python.org/pypi/las-geoh5/
.. |precommit_ci| image:: https://results.pre-commit.ci/badge/github/MiraGeoscience/las-geoh5/develop.svg
:alt: pre-commit.ci status
:target: https://results.pre-commit.ci/latest/github/MiraGeoscience/las-geoh5/develop
.. |maintainability| image:: https://api.codeclimate.com/v1/badges/_token_/maintainability
:target: https://codeclimate.com/github/MiraGeoscience/las-geoh5/maintainability
:alt: Maintainability
las-geoh5
=========
Import/Export LAS files to/from geoh5 format.
This package allows for import and export of LAS files to and from a drillhole group.
There is a module each for import and export operations. Each of these includes a driver
and a ui.json that parameterizes the driver and renders a UI for use within `Geoscience ANALYST Pro`_.
Read on to learn how to install las-geoh5 and get started importing and exporting LAS files.
.. contents:: Table of Contents
:local:
:depth: 3
Documentation
-------------
`Online documentation <https://mirageoscience-las-geoh5.readthedocs-hosted.com/en/latest/>`_
Installation
------------
Install **las-geoh5** with ``pip`` from PyPI::
$ pip install las-geoh5
Or from a branch on `github <https://github.com/MiraGeoscience/las-geoh5>`_::
$ pip install --upgrade --force-reinstall https://github.com/MiraGeoscience/las-geoh5/archive/refs/heads/BRANCH_NAME.zip
(to use a tag rather than a branch, replace ``heads\BRANCH_NAME.zip`` by ``tags\TAG_NAME.zip``)
Or from a local sources, after you have cloned the repository::
$ git clone https://github.com/MiraGeoscience/las-geoh5 [-b BRANCH_NAME]
$ pip install -e las-geoh5
Basic Usage
-----------
From Geoscience Analyst
~~~~~~~~~~~~~~~~~~~~~~~
.. _Geoscience ANALYST Pro: https://mirageoscience.com/mining-industry-software/geoscience-analyst-pro/
The most convenient way to use this package is through `Geoscience ANALYST Pro`_
where the import files driver may be run from the **file -> import**
menu.
All drivers may also be run from a ui.json file in `Geoscience ANALYST Pro`_
by either adding to the Python Scripts directory or drag and drop into
the viewport. Defaulted ui.json files can be found in the uijson folder
of the las-geoh5 project.
From command line
~~~~~~~~~~~~~~~~~
To run from command line, prepare first a JSON file with the parameters required for conversion.
Then execute with::
$ las_to_geoh5 parameters.json [-o output_geoh5]
$ geoh5_to_las parameters.json [-o output_dir]
where ``parameters.json`` is the path on disk to a JSON file with required input parameters.
If optional ``-o`` (or ``--out``) value is not provided, the program will write out to the location
specified by the JSON file.
License
-------
MIT License
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 curve-apps 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: ./docs/THIRD_PARTY_SOFTWARE.rst
Copyright
---------
Copyright (c) 2024 Mira Geoscience
Raw data
{
"_id": null,
"home_page": "https://www.mirageoscience.com/mining-industry-software/python-integration/",
"name": "las-geoh5",
"maintainer": "Benjamin Kary",
"docs_url": null,
"requires_python": "<3.11,>=3.10",
"maintainer_email": "benjamink@mirageoscience.com",
"keywords": "geology, geophysics, earth sciences, io, data, interoperability",
"author": "Mira Geoscience",
"author_email": "support@mirageoscience.com",
"download_url": "https://files.pythonhosted.org/packages/25/e8/0730f03672d75db6ea7055fa3bb26cbe0d446e737041019aaca9f2ce6b5c/las_geoh5-0.2.2.tar.gz",
"platform": null,
"description": "|coverage| |maintainability| |precommit_ci| |docs| |style| |version| |status| |pyversions|\n\n\n.. |docs| image:: https://readthedocs.com/projects/mirageoscience-las-geoh5/badge/?version=latest\n :alt: Documentation Status\n :target: https://mirageoscience-las-geoh5.readthedocs-hosted.com/en/latest/?badge=latest\n\n.. |coverage| image:: https://codecov.io/gh/MiraGeoscience/las-geoh5/branch/develop/graph/badge.svg\n :alt: Code coverage\n :target: https://codecov.io/gh/MiraGeoscience/las-geoh5\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/las-geoh5.svg\n :alt: version on PyPI\n :target: https://pypi.python.org/pypi/las-geoh5/\n\n.. |status| image:: https://img.shields.io/pypi/status/las-geoh5.svg\n :alt: version status on PyPI\n :target: https://pypi.python.org/pypi/las-geoh5/\n\n.. |pyversions| image:: https://img.shields.io/pypi/pyversions/las-geoh5.svg\n :alt: Python versions\n :target: https://pypi.python.org/pypi/las-geoh5/\n\n.. |precommit_ci| image:: https://results.pre-commit.ci/badge/github/MiraGeoscience/las-geoh5/develop.svg\n :alt: pre-commit.ci status\n :target: https://results.pre-commit.ci/latest/github/MiraGeoscience/las-geoh5/develop\n\n.. |maintainability| image:: https://api.codeclimate.com/v1/badges/_token_/maintainability\n :target: https://codeclimate.com/github/MiraGeoscience/las-geoh5/maintainability\n :alt: Maintainability\n\n\nlas-geoh5\n=========\n\nImport/Export LAS files to/from geoh5 format.\n\nThis package allows for import and export of LAS files to and from a drillhole group.\nThere is a module each for import and export operations. Each of these includes a driver\nand a ui.json that parameterizes the driver and renders a UI for use within `Geoscience ANALYST Pro`_.\nRead on to learn how to install las-geoh5 and get started importing and exporting LAS files.\n\n.. contents:: Table of Contents\n :local:\n :depth: 3\n\nDocumentation\n-------------\n`Online documentation <https://mirageoscience-las-geoh5.readthedocs-hosted.com/en/latest/>`_\n\n\nInstallation\n------------\n\nInstall **las-geoh5** with ``pip`` from PyPI::\n\n $ pip install las-geoh5\n\n\nOr from a branch on `github <https://github.com/MiraGeoscience/las-geoh5>`_::\n\n $ pip install --upgrade --force-reinstall https://github.com/MiraGeoscience/las-geoh5/archive/refs/heads/BRANCH_NAME.zip\n\n(to use a tag rather than a branch, replace ``heads\\BRANCH_NAME.zip`` by ``tags\\TAG_NAME.zip``)\n\n\nOr from a local sources, after you have cloned the repository::\n\n $ git clone https://github.com/MiraGeoscience/las-geoh5 [-b BRANCH_NAME]\n $ pip install -e las-geoh5\n\n\nBasic Usage\n-----------\n\nFrom Geoscience Analyst\n~~~~~~~~~~~~~~~~~~~~~~~\n.. _Geoscience ANALYST Pro: https://mirageoscience.com/mining-industry-software/geoscience-analyst-pro/\n\nThe most convenient way to use this package is through `Geoscience ANALYST Pro`_\nwhere the import files driver may be run from the **file -> import**\nmenu.\n\nAll drivers may also be run from a ui.json file in `Geoscience ANALYST Pro`_\nby either adding to the Python Scripts directory or drag and drop into\nthe viewport. Defaulted ui.json files can be found in the uijson folder\nof the las-geoh5 project.\n\nFrom command line\n~~~~~~~~~~~~~~~~~\nTo run from command line, prepare first a JSON file with the parameters required for conversion.\n\nThen execute with::\n\n $ las_to_geoh5 parameters.json [-o output_geoh5]\n $ geoh5_to_las parameters.json [-o output_dir]\n\nwhere ``parameters.json`` is the path on disk to a JSON file with required input parameters.\n\nIf optional ``-o`` (or ``--out``) value is not provided, the program will write out to the location\nspecified by the JSON file.\n\nLicense\n-------\n\nMIT License\n\nPermission is hereby granted, free of charge, to any person obtaining a\ncopy of this software and associated documentation files (the\n\u201cSoftware\u201d), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be included\nin all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS\nOR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n\nThird Party Software\n--------------------\n\nThe curve-apps 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: ./docs/THIRD_PARTY_SOFTWARE.rst\n\nCopyright\n---------\n\nCopyright (c) 2024 Mira Geoscience\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Las/Geoh5 conversion",
"version": "0.2.2",
"project_urls": {
"Documentation": "https://mirageoscience-las-geoh5.readthedocs-hosted.com/",
"Homepage": "https://www.mirageoscience.com/mining-industry-software/python-integration/",
"Repository": "https://github.com/MiraGeoscience/las-geoh5"
},
"split_keywords": [
"geology",
" geophysics",
" earth sciences",
" io",
" data",
" interoperability"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a7db85941848cc6f97a4742965493b24f6d7974a3756fd17f7d3cc7f74cfb043",
"md5": "c70d7bcc0440d3e3df381a6a2ee026e9",
"sha256": "7a9ff33a3720693d04197c715d38c3b4b316d550d64ae9e878167a4621f03ecb"
},
"downloads": -1,
"filename": "las_geoh5-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c70d7bcc0440d3e3df381a6a2ee026e9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.11,>=3.10",
"size": 30842,
"upload_time": "2024-09-11T14:51:45",
"upload_time_iso_8601": "2024-09-11T14:51:45.572738Z",
"url": "https://files.pythonhosted.org/packages/a7/db/85941848cc6f97a4742965493b24f6d7974a3756fd17f7d3cc7f74cfb043/las_geoh5-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "25e80730f03672d75db6ea7055fa3bb26cbe0d446e737041019aaca9f2ce6b5c",
"md5": "c0327d3f59e2e62c3ae0a9dc1f2613e9",
"sha256": "bd24b2ef809194f16be7501c6724f1ca80f0d1402a96f848413fad41a10bd745"
},
"downloads": -1,
"filename": "las_geoh5-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "c0327d3f59e2e62c3ae0a9dc1f2613e9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.11,>=3.10",
"size": 18523,
"upload_time": "2024-09-11T14:51:46",
"upload_time_iso_8601": "2024-09-11T14:51:46.860543Z",
"url": "https://files.pythonhosted.org/packages/25/e8/0730f03672d75db6ea7055fa3bb26cbe0d446e737041019aaca9f2ce6b5c/las_geoh5-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-11 14:51:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MiraGeoscience",
"github_project": "las-geoh5",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "las-geoh5"
}
JSON
