Metadata-Version: 2.1
Name: composite_ufjc_scission
Version: 1.3.7
Summary: The Python package for the composite uFJC model with scission.
Home-page: https://github.com/jasonmulderrig/composite-uFJC-scission
Author: Jason Mulderrig, Brandon Talamini, Nikolaos Bouklas
Author-email: jpm445@cornell.edu, talamini1@llnl.gov, nb589@cornell.edu
Maintainer: Jason Mulderrig
Maintainer-email: jpm445@cornell.edu, mulderrig.jason@gmail.com
License: GNU General Public License v3 or later (GPLv3+)
Keywords: ufjc,diffuse chain scission,asymptotic matching,thermodynamics,statistical mechanics,chain extensibility,polymer chain scission,distorted bond potential,dissipated energy,fracture toughness
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: Unix
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
Classifier: Topic :: Scientific/Engineering
Requires-Python: <4,>=3.5
Provides-Extra: plotting
License-File: LICENSE

#######################
composite uFJC scission
#######################

|build| |pyversions| |pypi| |license| |zenodo|

The Python package for the composite uFJC model with scission.

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

This package can be installed using ``pip`` via the `Python Package Index <https://pypi.org/project/composite-ufjc-scission/>`_ (PyPI),

::

    pip install composite-ufjc-scission

Alternatively, a branch can be directly installed using

::

    pip install git+https://github.com/jasonmulderrig/composite-uFJC-scission.git@<branch-name>

or after cloning a branch, moving to the main project directory (where the setup and configuration files are located), and executing ``pip install -e .`` for an editable installation or ``pip install .`` for a standard installation.

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

- `License <https://github.com/jasonmulderrig/composite-uFJC-scission/LICENSE>`__
- `Releases <https://github.com/jasonmulderrig/composite-uFJC-scission/releases>`__
- `Repository <https://github.com/jasonmulderrig/composite-uFJC-scission>`__

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

\Jason Mulderrig, Brandon Talamini, and Nikolaos Bouklas, ``composite-ufjc-scission``: the Python package for the composite uFJC model with scission, `Zenodo (2022) <https://doi.org/10.5281/zenodo.7335564>`_.

\Jason Mulderrig, Brandon Talamini, and Nikolaos Bouklas, A statistical mechanics framework for polymer chain scission, based on the concepts of distorted bond potential and asymptotic matching, `Journal of the Mechanics and Physics of Solids 174, 105244 (2023) <https://www.sciencedirect.com/science/article/pii/S0022509623000480>`_.

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

.. |build| image:: https://img.shields.io/github/checks-status/jasonmulderrig/composite-uFJC-scission/main?label=GitHub&logo=github
    :target: https://github.com/jasonmulderrig/composite-uFJC-scission

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

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

.. |license| image:: https://img.shields.io/github/license/jasonmulderrig/composite-uFJC-scission?label=License
    :target: https://github.com/jasonmulderrig/composite-uFJC-scission/LICENSE

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