discretize

Discretization tools for finite volume and inverse problems.

Science Score: 77.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 3 DOI reference(s) in README
✓
Academic publication links
Links to: zenodo.org
✓
Committers with academic emails
8 of 41 committers (19.5%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.5%) to scientific vocabulary

Keywords

finite-difference finite-volume inverse-problems linear-algebra partial-differential-equations scientific-computing simulation

Keywords from Contributors

geophysics geoscience electromagnetics open-science direct-current-resistivity induced-polarization inversion magnetotellurics multiphysics richards-equation

Last synced: 4 months ago · JSON representation ·

Repository

Discretization tools for finite volume and inverse problems.

Basic Info

Host: GitHub
Owner: simpeg
License: mit
Language: Python
Default Branch: main
Homepage: http://discretize.simpeg.xyz/
Size: 56 MB

Statistics

Stars: 183
Watchers: 20
Forks: 36
Open Issues: 43
Releases: 55

Topics

finite-difference finite-volume inverse-problems linear-algebra partial-differential-equations scientific-computing simulation

Created about 9 years ago · Last pushed 5 months ago

Metadata Files

Readme License Citation Authors

README.rst

.. 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/simpeg-purple?logo=mattermost&label=Mattermost
    :target: https://mattermost.softwareunderground.org/simpeg

.. 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, and is the recommended installation method.

.. code:: shell

    conda install -c conda-forge discretize

Prebuilt wheels of **discretize** are on pypi for most platforms

.. code:: shell

    pip install discretize

To install from source, note this requires a `c++` compiler supporting the `c++17` standard.

.. code:: shell

    git clone https://github.com/simpeg/discretize.git
    cd discretize
    pip 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:
https://mattermost.softwareunderground.org/simpeg

Owner

Name: SimPEG
Login: simpeg
Kind: organization
Email: info@simpeg.xyz

Website: http://simpeg.xyz
Repositories: 37
Profile: https://github.com/simpeg

A community and tools for open geophysics.

Citation (CITATION.rst)

Citing discretize
-----------------

There is a `paper about discretize <http://dx.doi.org/10.1016/j.cageo.2015.09.015>`_ as it is used in SimPEG,
if you use this code, please help our scientific visibility by citing our 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{Cockett2015,
      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}
    }

GitHub Events

Total

Create event: 10
Release event: 4
Issues event: 12
Watch event: 14
Delete event: 8
Issue comment event: 52
Push event: 47
Pull request event: 35
Pull request review comment event: 8
Pull request review event: 14
Fork event: 2

Last Year

Create event: 10
Release event: 4
Issues event: 12
Watch event: 14
Delete event: 8
Issue comment event: 52
Push event: 47
Pull request event: 35
Pull request review comment event: 8
Pull request review event: 14
Fork event: 2

Committers

Last synced: almost 2 years ago

All Time

Total Commits: 4,542
Total Committers: 41
Avg Commits per committer: 110.78
Development Distribution Score (DDS): 0.803

Past Year

Commits: 246
Committers: 5
Avg Commits per committer: 49.2
Development Distribution Score (DDS): 0.191

Top Committers

Name	Email	Commits
Lindsey Heagy	l**y@g**m	895
rowanc1	r**n@v**m	788
Joseph Capriotti	j**i@g**m	762
Lindsey Heagy	l**y@e**a	290
Rowan Cockett	r**n@3**m	241
Rowan Cockett	r**1@g**m	220
GudniRos	g**n@g**m	217
D Fournier	f**o@g**m	193
seogi_macbook	s**9@g**m	166
Joseph Capriotti	j**t@m**u	165
dccowan	d**n@g**m	100
seogi	s**9@g**m	83
Bane Sullivan	b**n@g**m	75
Dave Marchant	d**t@g**m	68
Dieter Werthmüller	m**l@w**g	62
Santiago Soler	s**r@f**m	44
Michael Mitchell	m**4@g**m	37
Thibaut Astic	t**t@e**a	33
Gudni Karl	g**j@e**a	19
ehaber99	e**9@g**m	15
Lars Ruthotto	l**o@e**a	10
Dominique Fournier	d**f@m**m	10
prisae	d**r@w**g	9
micmitch	m**l@e**a	6
Luz Angelica Caudillo Mata	l**z@g**m	6
Neil	n**r@g**m	4
Dieter Werthmüller	p****e	4
Colton Kohnke	c**e@g**m	3
Brendan Smithyman	s**n@g**m	3
fwkoch	f**n@3**m	3
and 11 more...

Committer Domains (Top 20 + Academic)

eos.ubc.ca: 6 werthmuller.org: 2 3ptscience.com: 2 quantifiedcode.com: 1 bitsmithy.net: 1 uci.edu: 1 cwgeophysics.ca: 1 mirageoscience.com: 1 fastmail.com: 1 mines.edu: 1 github.com: 1 visiblegeology.com: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 65
Total pull requests: 105
Average time to close issues: over 2 years
Average time to close pull requests: about 2 months
Total issue authors: 27
Total pull request authors: 12
Average comments per issue: 2.03
Average comments per pull request: 2.4
Merged pull requests: 82
Bot issues: 0
Bot pull requests: 1

Past Year

Issues: 5
Pull requests: 11
Average time to close issues: N/A
Average time to close pull requests: 4 days
Issue authors: 3
Pull request authors: 3
Average comments per issue: 0.0
Average comments per pull request: 1.18
Merged pull requests: 7
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

lheagy (13)
rowanc1 (7)
jcapriot (5)
domfournier (5)
dccowan (4)
santisoler (3)
ngodber (3)
williamjsdavis (3)
banesullivan (3)
prisae (3)
nwilliams-kobold (1)
thast (1)
micmitch (1)
shashwat97 (1)
marrov (1)

Pull Request Authors

jcapriot (72)
santisoler (23)
prisae (11)
lheagy (7)
omid-b (4)
dccowan (3)
ngodber (2)
dependabot[bot] (2)
xiaolongw1223 (2)
rowanc1 (1)
thibaut-kobold (1)
munahaf (1)

Top Labels

Issue Labels

bug (7) enhancement (4) TreeMesh (4) mesh (3) docs (2) CylMesh (2) viz (1) community (1) question (1) help wanted (1)

Pull Request Labels

enhancement (3) in progress (2) dependencies (2) mesh (1) ready for review (1) CylMesh (1)

Packages

Total packages: 2
Total downloads:
- pypi 8,324 last-month
Total docker downloads: 158

Total dependent packages: 14
(may contain duplicates)
Total dependent repositories: 43
(may contain duplicates)
Total versions: 95
Total maintainers: 4

pypi.org: discretize

Discretization tools for finite volume and inverse problems

Homepage: https://simpeg.xyz
Documentation: https://discretize.simpeg.xyz
License: The MIT License (MIT) Copyright (c) 2013-2025 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.
Latest release: 0.11.3
published 7 months ago

Versions: 77
Dependent Packages: 13
Dependent Repositories: 32
Downloads: 8,324 Last month
Docker Downloads: 158

Rankings

Dependent packages count: 0.9%

Docker downloads count: 1.7%

Dependent repos count: 2.6%

Average: 4.1%

Stargazers count: 5.7%

Downloads: 6.4%

Forks count: 7.3%

Maintainers (4)

lheagy rowanc1 thast jcapriot

Last synced: 5 months ago

conda-forge.org: discretize

Homepage: http://github.com/simpeg/discretize
License: MIT
Latest release: 0.8.2
published over 3 years ago

Versions: 18
Dependent Packages: 1
Dependent Repositories: 11

Rankings

Dependent repos count: 10.7%

Average: 26.0%

Dependent packages count: 29.0%

Stargazers count: 29.7%

Forks count: 34.8%

Last synced: 5 months ago

Dependencies

requirements_dev.txt pypi

cython * development
matplotlib * development
nbsphinx * development
numpydoc * development
omf * development
pillow * development
pydata-sphinx-theme * development
pylint * development
pymatsolver >=0.1.2 development
pytest * development
pytest-cov * development
pyvista >=0.20.1 development
setuptools_scm * development
sphinx * development
sphinx-gallery * development
sphinx-toolbox * development
sphinx_rtd_theme * development
sphinxcontrib-apidoc * development
sympy * development
twine * development
vtk * development
wheel * development

setup.py pypi

numpy >=1.8
scipy >=0.13

requirements_style.txt pypi

black ==23.1a1
flake8 *
flake8-bugbear *
flake8-builtins *
flake8-docstrings >=1.7
flake8-mutable *
flake8-rst-docstrings *

requirements.txt pypi