discretize


Namediscretize JSON
Version 0.10.0 PyPI version JSON
download
home_page
SummaryDiscretization tools for finite volume and inverse problems
upload_time2023-10-27 22:51:09
maintainer
docs_urlNone
author
requires_python>=3.8
licenseThe MIT License (MIT) Copyright (c) 2013-2023 SimPEG Developers 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.
keywords finite volume discretization pde ode
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            .. image:: https://raw.github.com/simpeg/discretize/main/docs/images/discretize-logo.png
    :alt: Discretize Logo

discretize
==========

.. image:: https://img.shields.io/pypi/v/discretize.svg
    :target: https://pypi.python.org/pypi/discretize
    :alt: Latest PyPI version

.. image:: https://anaconda.org/conda-forge/discretize/badges/version.svg
    :target: https://anaconda.org/conda-forge/discretize
    :alt: Latest conda-forge version

.. image:: https://img.shields.io/github/license/simpeg/simpeg.svg
    :target: https://github.com/simpeg/discretize/blob/main/LICENSE
    :alt: MIT license

.. image:: https://dev.azure.com/simpeg/discretize/_apis/build/status/simpeg.discretize?branchName=main
    :target: https://dev.azure.com/simpeg/discretize/_build/latest?definitionId=1&branchName=main
    :alt: Azure pipelines build status

.. image:: https://codecov.io/gh/simpeg/discretize/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/simpeg/discretize
    :alt: Coverage status

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.596411.svg
   :target: https://doi.org/10.5281/zenodo.596411

.. image:: https://img.shields.io/discourse/users?server=http%3A%2F%2Fsimpeg.discourse.group%2F
    :target: http://simpeg.discourse.group/

.. image:: https://img.shields.io/badge/Slack-simpeg-4B0082.svg?logo=slack
    :target: http://slack.simpeg.xyz

.. image:: https://img.shields.io/badge/Youtube%20channel-GeoSci.xyz-FF0000.svg?logo=youtube
    :target: https://www.youtube.com/channel/UCBrC4M8_S4GXhyHht7FyQqw


**discretize** - A python package for finite volume discretization.

The vision is to create a package for finite volume simulation with a
focus on large scale inverse problems.
This package has the following features:

* modular with respect to the spacial discretization
* built with the inverse problem in mind
* supports 1D, 2D and 3D problems
* access to sparse matrix operators
* access to derivatives to mesh variables

.. image:: https://raw.githubusercontent.com/simpeg/figures/master/finitevolume/cell-anatomy-tensor.png

Currently, discretize supports:

* Tensor Meshes (1D, 2D and 3D)
* Cylindrically Symmetric Meshes
* QuadTree and OcTree Meshes (2D and 3D)
* Logically Rectangular Meshes (2D and 3D)
* Triangular (2D) and Tetrahedral (3D) Meshes

Installing
^^^^^^^^^^
**discretize** is on conda-forge

.. code:: shell

    conda install -c conda-forge discretize

**discretize** is on pypi

.. code:: shell

    pip install discretize

To install from source

.. code:: shell

    git clone https://github.com/simpeg/discretize.git
    python setup.py install

Citing discretize
^^^^^^^^^^^^^^^^^

Please cite the SimPEG paper when using discretize in your work:


    Cockett, R., Kang, S., Heagy, L. J., Pidlisecky, A., & Oldenburg, D. W. (2015). SimPEG: An open source framework for simulation and gradient based parameter estimation in geophysical applications. Computers & Geosciences.

**BibTex:**

.. code:: Latex

    @article{cockett2015simpeg,
      title={SimPEG: An open source framework for simulation and gradient based parameter estimation in geophysical applications},
      author={Cockett, Rowan and Kang, Seogi and Heagy, Lindsey J and Pidlisecky, Adam and Oldenburg, Douglas W},
      journal={Computers \& Geosciences},
      year={2015},
      publisher={Elsevier}
    }

Links
^^^^^

Website:
http://simpeg.xyz

Documentation:
http://discretize.simpeg.xyz

Code:
https://github.com/simpeg/discretize

Tests:
https://travis-ci.org/simpeg/discretize

Bugs & Issues:
https://github.com/simpeg/discretize/issues

Questions:
http://simpeg.discourse.group/

Chat:
http://slack.simpeg.xyz/

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "discretize",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "finite volume discretization pde ode",
    "author": "",
    "author_email": "SimPEG developers <rowanc1@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/26/9a/066af921369d9a0fe9ffa8dac2d3c0da79bd3e618c33c9495df57789c2af/discretize-0.10.0.tar.gz",
    "platform": null,
    "description": ".. image:: https://raw.github.com/simpeg/discretize/main/docs/images/discretize-logo.png\n    :alt: Discretize Logo\n\ndiscretize\n==========\n\n.. image:: https://img.shields.io/pypi/v/discretize.svg\n    :target: https://pypi.python.org/pypi/discretize\n    :alt: Latest PyPI version\n\n.. image:: https://anaconda.org/conda-forge/discretize/badges/version.svg\n    :target: https://anaconda.org/conda-forge/discretize\n    :alt: Latest conda-forge version\n\n.. image:: https://img.shields.io/github/license/simpeg/simpeg.svg\n    :target: https://github.com/simpeg/discretize/blob/main/LICENSE\n    :alt: MIT license\n\n.. image:: https://dev.azure.com/simpeg/discretize/_apis/build/status/simpeg.discretize?branchName=main\n    :target: https://dev.azure.com/simpeg/discretize/_build/latest?definitionId=1&branchName=main\n    :alt: Azure pipelines build status\n\n.. image:: https://codecov.io/gh/simpeg/discretize/branch/main/graph/badge.svg\n    :target: https://codecov.io/gh/simpeg/discretize\n    :alt: Coverage status\n\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.596411.svg\n   :target: https://doi.org/10.5281/zenodo.596411\n\n.. image:: https://img.shields.io/discourse/users?server=http%3A%2F%2Fsimpeg.discourse.group%2F\n    :target: http://simpeg.discourse.group/\n\n.. image:: https://img.shields.io/badge/Slack-simpeg-4B0082.svg?logo=slack\n    :target: http://slack.simpeg.xyz\n\n.. image:: https://img.shields.io/badge/Youtube%20channel-GeoSci.xyz-FF0000.svg?logo=youtube\n    :target: https://www.youtube.com/channel/UCBrC4M8_S4GXhyHht7FyQqw\n\n\n**discretize** - A python package for finite volume discretization.\n\nThe vision is to create a package for finite volume simulation with a\nfocus on large scale inverse problems.\nThis package has the following features:\n\n* modular with respect to the spacial discretization\n* built with the inverse problem in mind\n* supports 1D, 2D and 3D problems\n* access to sparse matrix operators\n* access to derivatives to mesh variables\n\n.. image:: https://raw.githubusercontent.com/simpeg/figures/master/finitevolume/cell-anatomy-tensor.png\n\nCurrently, discretize supports:\n\n* Tensor Meshes (1D, 2D and 3D)\n* Cylindrically Symmetric Meshes\n* QuadTree and OcTree Meshes (2D and 3D)\n* Logically Rectangular Meshes (2D and 3D)\n* Triangular (2D) and Tetrahedral (3D) Meshes\n\nInstalling\n^^^^^^^^^^\n**discretize** is on conda-forge\n\n.. code:: shell\n\n    conda install -c conda-forge discretize\n\n**discretize** is on pypi\n\n.. code:: shell\n\n    pip install discretize\n\nTo install from source\n\n.. code:: shell\n\n    git clone https://github.com/simpeg/discretize.git\n    python setup.py install\n\nCiting discretize\n^^^^^^^^^^^^^^^^^\n\nPlease cite the SimPEG paper when using discretize in your work:\n\n\n    Cockett, R., Kang, S., Heagy, L. J., Pidlisecky, A., & Oldenburg, D. W. (2015). SimPEG: An open source framework for simulation and gradient based parameter estimation in geophysical applications. Computers & Geosciences.\n\n**BibTex:**\n\n.. code:: Latex\n\n    @article{cockett2015simpeg,\n      title={SimPEG: An open source framework for simulation and gradient based parameter estimation in geophysical applications},\n      author={Cockett, Rowan and Kang, Seogi and Heagy, Lindsey J and Pidlisecky, Adam and Oldenburg, Douglas W},\n      journal={Computers \\& Geosciences},\n      year={2015},\n      publisher={Elsevier}\n    }\n\nLinks\n^^^^^\n\nWebsite:\nhttp://simpeg.xyz\n\nDocumentation:\nhttp://discretize.simpeg.xyz\n\nCode:\nhttps://github.com/simpeg/discretize\n\nTests:\nhttps://travis-ci.org/simpeg/discretize\n\nBugs & Issues:\nhttps://github.com/simpeg/discretize/issues\n\nQuestions:\nhttp://simpeg.discourse.group/\n\nChat:\nhttp://slack.simpeg.xyz/\n",
    "bugtrack_url": null,
    "license": "The MIT License (MIT)  Copyright (c) 2013-2023 SimPEG Developers  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.",
    "summary": "Discretization tools for finite volume and inverse problems",
    "version": "0.10.0",
    "project_urls": {
        "Documentation": "https://discretize.simpeg.xyz",
        "Homepage": "https://simpeg.xyz",
        "Repository": "http://github.com/simpeg/discretize.git"
    },
    "split_keywords": [
        "finite",
        "volume",
        "discretization",
        "pde",
        "ode"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "269a066af921369d9a0fe9ffa8dac2d3c0da79bd3e618c33c9495df57789c2af",
                "md5": "506aeb1077fb8c382f42931341e6cf23",
                "sha256": "00893a29d2a870500967bf99aa3cf31a35d867976c28e983788e4abad19cf608"
            },
            "downloads": -1,
            "filename": "discretize-0.10.0.tar.gz",
            "has_sig": false,
            "md5_digest": "506aeb1077fb8c382f42931341e6cf23",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 247847,
            "upload_time": "2023-10-27T22:51:09",
            "upload_time_iso_8601": "2023-10-27T22:51:09.664700Z",
            "url": "https://files.pythonhosted.org/packages/26/9a/066af921369d9a0fe9ffa8dac2d3c0da79bd3e618c33c9495df57789c2af/discretize-0.10.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-27 22:51:09",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "simpeg",
    "github_project": "discretize",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": false,
    "lcname": "discretize"
}
        
Elapsed time: 0.14875s