Metadata-Version: 2.1
Name: statmechcrack
Version: 0.2.1
Summary: The Python package for         a statistical mechanical model for crack growth.
Home-page: https://sandialabs.github.io/statMechCrack
Author: Michael R. Buche, Scott J. Grutzik
Author-email: mrbuche@sandia.gov, sjgrutz@sandia.gov
License: BSD-3-Clause
Project-URL: Anaconda, https://anaconda.org/mrbuche/statmechcrack
Project-URL: Documentation, https://statmechcrack.readthedocs.io/en/latest
Project-URL: GitHub, https://github.com/sandialabs/statmechcrack
Project-URL: Issues, https://github.com/sandialabs/statmechcrack/issues
Keywords: fracture mechanics,statistical mechanics,thermodynamics
Classifier: License :: OSI Approved :: BSD License
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
License-File: LICENSE
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: scipy
Provides-Extra: all
Requires-Dist: docutils (<0.18,>=0.14) ; extra == 'all'
Requires-Dist: ipykernel ; extra == 'all'
Requires-Dist: ipython ; extra == 'all'
Requires-Dist: jinja2 (>=3.0) ; extra == 'all'
Requires-Dist: nbsphinx ; extra == 'all'
Requires-Dist: pycodestyle ; extra == 'all'
Requires-Dist: pylint ; extra == 'all'
Requires-Dist: pytest ; extra == 'all'
Requires-Dist: pytest-cov ; extra == 'all'
Requires-Dist: sphinx ; extra == 'all'
Requires-Dist: sphinx-copybutton ; extra == 'all'
Requires-Dist: sphinx-rtd-theme ; extra == 'all'
Requires-Dist: sphinxcontrib-bibtex ; extra == 'all'
Provides-Extra: docs
Requires-Dist: docutils (<0.18,>=0.14) ; extra == 'docs'
Requires-Dist: ipykernel ; extra == 'docs'
Requires-Dist: ipython ; extra == 'docs'
Requires-Dist: jinja2 (>=3.0) ; extra == 'docs'
Requires-Dist: nbsphinx ; extra == 'docs'
Requires-Dist: pycodestyle ; extra == 'docs'
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: sphinx-copybutton ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Requires-Dist: sphinxcontrib-bibtex ; extra == 'docs'
Provides-Extra: testing
Requires-Dist: pycodestyle ; extra == 'testing'
Requires-Dist: pylint ; extra == 'testing'
Requires-Dist: pytest ; extra == 'testing'
Requires-Dist: pytest-cov ; extra == 'testing'

#############
statMechCrack
#############

|build| |docs| |codecov| |coveralls| |pylint| |codeql| |pyversions| |pypi| |conda| |docker| |license| |zenodo|

The Python package for a statistical mechanical model for crack growth. 

************
Installation
************

The package can be installed using ``pip`` via the `Python Package Index <https://pypi.org/project/statmechcrack>`_ (PyPI),

::

    pip install statmechcrack

or using ``conda`` via the ``mrbuche`` channel on `Anaconda <https://anaconda.org/mrbuche/statmechcrack>`_,

::

    conda install --channel mrbuche statmechcrack
    
Alternatively, a branch can be directly installed using

::

    pip install git+https://github.com/sandialabs/statmechcrack.git@<branch-name>

or after cloning a branch and executing ``python setup.py install``.
There are also `Docker images <https://hub.docker.com/r/mrbuche/statmechcrack>`_ available for use.
In all of these cases, a valid installation can be tested by running

::

    python -m statmechcrack.tests

***********
Information
***********

- `Contributing <https://github.com/sandialabs/statMechCrack/blob/main/CONTRIBUTING.md>`__
- `Documentation <https://sandialabs.github.io/statMechCrack>`__
- `License <https://github.com/sandialabs/statmechcrack/blob/main/LICENSE>`__
- `Releases <https://github.com/sandialabs/statmechcrack/releases>`__
- `Repository <https://github.com/sandialabs/statmechcrack>`__
- `Tutorial <https://sandialabs.github.io/statMechCrack/tutorial.html>`__

********
Citation
********

\M. R. Buche and S. J. Grutzik, ``statMechCrack``: the Python package for a statistical mechanical model for crack growth, `Zenodo (2022) <https://doi.org/10.5281/zenodo.7008312>`_.

*********
Copyright
*********

Copyright 2022 National Technology & Engineering Solutions of Sandia, LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S. Government retains certain rights in this software.

..
    Badges ========================================================================

.. |docs| image:: https://img.shields.io/readthedocs/statmechcrack?logo=readthedocs&label=Read%20the%20Docs
    :target: https://statmechcrack.readthedocs.io/en/latest/

.. |build| image:: https://img.shields.io/github/workflow/status/sandialabs/statmechcrack/main?label=GitHub&logo=github
    :target: https://github.com/sandialabs/statmechcrack

.. |coveralls| image:: https://img.shields.io/coveralls/github/sandialabs/statMechCrack?logo=coveralls&label=Coveralls
    :target: https://coveralls.io/github/sandialabs/statMechCrack?branch=main

.. |codecov| image:: https://img.shields.io/codecov/c/github/sandialabs/statmechcrack?label=Codecov&logo=codecov
    :target: https://codecov.io/gh/sandialabs/statmechcrack

.. |pylint| image:: https://raw.githubusercontent.com/sandialabs/statmechcrack/gh-pages/pylint.svg
    :target: https://github.com/sandialabs/statmechcrack

.. |codeql| image:: https://img.shields.io/github/workflow/status/sandialabs/statmechcrack/CodeQL?label=CodeQL&logo=github
    :target: https://github.com/sandialabs/statMechCrack/security/code-scanning

.. |pyversions| image:: https://img.shields.io/pypi/pyversions/statmechcrack.svg?logo=python&logoColor=FBE072&color=4B8BBE&label=Python
    :target: https://pypi.org/project/statmechcrack/

.. |pypi| image:: https://img.shields.io/pypi/v/statmechcrack?logo=pypi&logoColor=FBE072&label=PyPI&color=4B8BBE
    :target: https://pypi.org/project/statmechcrack/

.. |conda| image:: https://img.shields.io/conda/v/mrbuche/statmechcrack.svg?logo=anaconda&color=3EB049&label=Anaconda
    :target: https://anaconda.org/mrbuche/statmechcrack/

.. |docker| image:: https://img.shields.io/docker/v/mrbuche/statmechcrack?color=0db7ed&label=Docker%20Hub&logo=docker&logoColor=0db7ed
    :target: https://hub.docker.com/r/mrbuche/statmechcrack

.. |license| image:: https://img.shields.io/github/license/sandialabs/statmechcrack?label=License
    :target: https://github.com/sandialabs/statmechcrack/blob/main/LICENSE

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