|coverage| |maintainability| |precommit_ci| |docs| |style| |version| |status| |pyversions|
.. |docs| image:: https://readthedocs.org/projects/curve-apps/badge/
:alt: Documentation Status
:target: https://curve-apps.readthedocs.io/en/latest/?badge=latest
.. |coverage| image:: https://codecov.io/gh/MiraGeoscience/curve-apps/branch/develop/graph/badge.svg
:alt: Code coverage
:target: https://codecov.io/gh/MiraGeoscience/curve-apps
.. |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/edge-detection.svg
:alt: version on PyPI
:target: https://pypi.python.org/pypi/edge-detection/
.. |status| image:: https://img.shields.io/pypi/status/edge-detection.svg
:alt: version status on PyPI
:target: https://pypi.python.org/pypi/edge-detection/
.. |pyversions| image:: https://img.shields.io/pypi/pyversions/edge-detection.svg
:alt: Python versions
:target: https://pypi.python.org/pypi/edge-detection/
.. |precommit_ci| image:: https://results.pre-commit.ci/badge/github/MiraGeoscience/edge-detection/develop.svg
:alt: pre-commit.ci status
:target: https://results.pre-commit.ci/latest/github/MiraGeoscience/edge-detection/develop
.. |maintainability| image:: https://api.codeclimate.com/v1/badges/_token_/maintainability
:target: https://codeclimate.com/github/MiraGeoscience/edge-detection/maintainability
:alt: Maintainability
curve-apps
==========
Auto-detection of trends and edges in geoscientific data.
.. contents:: Table of Contents
:local:
:depth: 3
Documentation
^^^^^^^^^^^^^
`Online documentation <https://edge-detection.readthedocs.io/en/latest/>`_
Installation
^^^^^^^^^^^^
**curve-apps** is currently written and tested for Python 3.10.
Install Conda
-------------
To install **curve-apps**, 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 **curve-apps**.
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 **curve-apps** package published on PyPI:
.. code-block:: bash
pip install -U --no-deps curve-apps
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/curve-apps/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/curve-apps/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 **curve-apps** 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
^^^^^^^
curve-apps is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
curve-apps is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with curve-apps. If not, see <https://www.gnu.org/licenses/>.
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 Ltd.
Raw data
{
"_id": null,
"home_page": "https://www.mirageoscience.com/mining-industry-software/python-integration/",
"name": "curve-apps",
"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/25/14/a569c8fa97aa0fabeb5e537fffe887f59d3a9f087223e0948b67a0ada27f/curve_apps-0.1.0.tar.gz",
"platform": null,
"description": "|coverage| |maintainability| |precommit_ci| |docs| |style| |version| |status| |pyversions|\n\n\n.. |docs| image:: https://readthedocs.org/projects/curve-apps/badge/\n :alt: Documentation Status\n :target: https://curve-apps.readthedocs.io/en/latest/?badge=latest\n\n.. |coverage| image:: https://codecov.io/gh/MiraGeoscience/curve-apps/branch/develop/graph/badge.svg\n :alt: Code coverage\n :target: https://codecov.io/gh/MiraGeoscience/curve-apps\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/edge-detection.svg\n :alt: version on PyPI\n :target: https://pypi.python.org/pypi/edge-detection/\n\n.. |status| image:: https://img.shields.io/pypi/status/edge-detection.svg\n :alt: version status on PyPI\n :target: https://pypi.python.org/pypi/edge-detection/\n\n.. |pyversions| image:: https://img.shields.io/pypi/pyversions/edge-detection.svg\n :alt: Python versions\n :target: https://pypi.python.org/pypi/edge-detection/\n\n.. |precommit_ci| image:: https://results.pre-commit.ci/badge/github/MiraGeoscience/edge-detection/develop.svg\n :alt: pre-commit.ci status\n :target: https://results.pre-commit.ci/latest/github/MiraGeoscience/edge-detection/develop\n\n.. |maintainability| image:: https://api.codeclimate.com/v1/badges/_token_/maintainability\n :target: https://codeclimate.com/github/MiraGeoscience/edge-detection/maintainability\n :alt: Maintainability\n\n\ncurve-apps\n==========\n\nAuto-detection of trends and edges in geoscientific data.\n\n.. contents:: Table of Contents\n :local:\n :depth: 3\n\nDocumentation\n^^^^^^^^^^^^^\n`Online documentation <https://edge-detection.readthedocs.io/en/latest/>`_\n\n\nInstallation\n^^^^^^^^^^^^\n**curve-apps** is currently written and tested for Python 3.10.\n\nInstall Conda\n-------------\n\nTo install **curve-apps**, 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 **curve-apps**.\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 **curve-apps** package published on PyPI:\n\n.. code-block:: bash\n\n pip install -U --no-deps curve-apps\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/curve-apps/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/curve-apps/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 **curve-apps** 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^^^^^^^\ncurve-apps is free software: you can redistribute it and/or modify\nit under the terms of the GNU Lesser General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\ncurve-apps is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU Lesser General Public License for more details.\n\nYou should have received a copy of the GNU Lesser General Public License\nalong with curve-apps. If not, see <https://www.gnu.org/licenses/>.\n\n\nThird Party Software\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^^^^^^^^^\nCopyright (c) 2024 Mira Geoscience Ltd.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Find edges on 2D grids or vertices.",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://mirageoscience-curve-apps.readthedocs-hosted.com/",
"Homepage": "https://www.mirageoscience.com/mining-industry-software/python-integration/",
"Repository": "https://github.com/MiraGeoscience/curve-apps"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0a6af159c152f439afe7e6a46325ef433cf361a50ffa9134fe52cb341785e698",
"md5": "10ae53cd3ce9416755d5570ab8348b73",
"sha256": "99d8ff5e37c4f2bafa1127ce99e2fb3fd65b1da5500b238f98dcbeb7f06e3b27"
},
"downloads": -1,
"filename": "curve_apps-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "10ae53cd3ce9416755d5570ab8348b73",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.11,>=3.9",
"size": 4452528,
"upload_time": "2024-06-17T18:15:11",
"upload_time_iso_8601": "2024-06-17T18:15:11.995427Z",
"url": "https://files.pythonhosted.org/packages/0a/6a/f159c152f439afe7e6a46325ef433cf361a50ffa9134fe52cb341785e698/curve_apps-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2514a569c8fa97aa0fabeb5e537fffe887f59d3a9f087223e0948b67a0ada27f",
"md5": "90577de9fd944abdd4ddd27187a7c944",
"sha256": "aeddca961637fb9cbc134b49d16c1a407f953ed38c4ea8174e745ec16886323b"
},
"downloads": -1,
"filename": "curve_apps-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "90577de9fd944abdd4ddd27187a7c944",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.11,>=3.9",
"size": 4443695,
"upload_time": "2024-06-17T18:15:18",
"upload_time_iso_8601": "2024-06-17T18:15:18.385086Z",
"url": "https://files.pythonhosted.org/packages/25/14/a569c8fa97aa0fabeb5e537fffe887f59d3a9f087223e0948b67a0ada27f/curve_apps-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-17 18:15:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MiraGeoscience",
"github_project": "curve-apps",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "curve-apps"
}
JSON
