####
uFJC
####
****************************************************************************************************************
THIS PACKAGE IS DEPRECATED. PLEASE USE THE `POLYMERS MODELING LIBRARY <https://sandialabs.github.io/Polymers>`_.
****************************************************************************************************************
|build| |docs| |codecov| |coveralls| |codefactor| |pyversions| |pypi| |conda| |docker| |license| |zenodo|
The Python package for the uFJC single-chain model.
************
Installation
************
The package can be installed using ``pip`` via the `Python Package Index <https://pypi.org/project/ufjc/>`_ (PyPI),
::
pip install ufjc
or using ``conda`` via the ``mrbuche`` channel on `Anaconda <https://anaconda.org/mrbuche/ufjc>`_,
::
conda install --channel mrbuche ufjc
Alternatively, a branch can be directly installed using
::
pip install git+https://github.com/sandialabs/ufjc.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/ufjc>`_ available for use.
In all of these cases, a valid installation can be tested by running
::
python -m ufjc.tests
***********
Information
***********
- `Contributing <https://ufjc.readthedocs.io/en/latest/CONTRIBUTING.html>`__
- `Documentation <https://ufjc.readthedocs.io/en/latest/>`__
- `Examples <https://ufjc.readthedocs.io/en/latest/ufjc.examples.html>`__
- `License <https://github.com/sandialabs/ufjc/blob/main/LICENSE>`__
- `Releases <https://github.com/sandialabs/ufjc/releases>`__
- `Repository <https://github.com/sandialabs/ufjc>`__
- `Tutorial <https://ufjc.readthedocs.io/en/latest/TUTORIAL.html>`__
********
Citation
********
\M. R. Buche and S. J. Grutzik, ``uFJC``: the Python package for the uFJC single-chain model, `Zenodo (2022) <https://doi.org/10.5281/zenodo.6114263>`_.
\M. R. Buche, M. N. Silberstein, and S. J. Grutzik, Freely jointed chain models with extensible links, `Physical Review E 106, 024502 (2022) <https://doi.org/10.1103/PhysRevE.106.024502>`_.
*********
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 ========================================================================
.. |build| image:: https://img.shields.io/github/actions/workflow/status/sandialabs/ufjc/main.yml?branch=main&label=GitHub&logo=github
:target: https://github.com/sandialabs/ufjc
.. |docs| image:: https://img.shields.io/readthedocs/ufjc?logo=readthedocs&label=Read%20the%20Docs
:target: https://ufjc.readthedocs.io/en/latest/
.. |codecov| image:: https://img.shields.io/codecov/c/github/sandialabs/ufjc?label=Codecov&logo=codecov
:target: https://codecov.io/gh/sandialabs/ufjc
.. |coveralls| image:: https://img.shields.io/coveralls/github/sandialabs/ufjc?logo=coveralls&label=Coveralls
:target: https://coveralls.io/github/sandialabs/ufjc?branch=main
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sandialabs/ufjc?label=Codefactor&logo=codefactor
:target: https://www.codefactor.io/repository/github/sandialabs/ufjc
.. |pyversions| image:: https://img.shields.io/pypi/pyversions/ufjc.svg?logo=python&logoColor=FBE072&color=4B8BBE&label=Python
:target: https://pypi.org/project/ufjc/
.. |pypi| image:: https://img.shields.io/pypi/v/ufjc?logo=pypi&logoColor=FBE072&label=PyPI&color=4B8BBE
:target: https://pypi.org/project/ufjc/
.. |conda| image:: https://img.shields.io/conda/v/mrbuche/ufjc.svg?logo=anaconda&color=3EB049&label=Anaconda
:target: https://anaconda.org/mrbuche/ufjc/
.. |docker| image:: https://img.shields.io/docker/v/mrbuche/ufjc?color=0db7ed&label=Docker%20Hub&logo=docker&logoColor=0db7ed
:target: https://hub.docker.com/r/mrbuche/ufjc
.. |license| image:: https://img.shields.io/github/license/sandialabs/ufjc?label=License
:target: https://github.com/sandialabs/ufjc/blob/main/LICENSE
.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.6114263.svg
:target: https://doi.org/10.5281/zenodo.6114263
Raw data
{
"_id": null,
"home_page": "https://sandialabs.github.io/uFJC",
"name": "ufjc",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "ufjc,polymers,statistical mechanics,thermodynamics",
"author": "Michael R. Buche, Scott J. Grutzik",
"author_email": "mrbuche@sandia.gov, sjgrutz@sandia.gov",
"download_url": "https://files.pythonhosted.org/packages/a8/3e/172e36fb97441f25029be08da914b1f688938d107deebf5bdfa62d8e5e22/ufjc-1.3.6.tar.gz",
"platform": null,
"description": "####\nuFJC\n####\n\n****************************************************************************************************************\nTHIS PACKAGE IS DEPRECATED. PLEASE USE THE `POLYMERS MODELING LIBRARY <https://sandialabs.github.io/Polymers>`_.\n****************************************************************************************************************\n\n|build| |docs| |codecov| |coveralls| |codefactor| |pyversions| |pypi| |conda| |docker| |license| |zenodo|\n\nThe Python package for the uFJC single-chain model.\n\n************\nInstallation\n************\n\nThe package can be installed using ``pip`` via the `Python Package Index <https://pypi.org/project/ufjc/>`_ (PyPI),\n\n::\n\n pip install ufjc\n\nor using ``conda`` via the ``mrbuche`` channel on `Anaconda <https://anaconda.org/mrbuche/ufjc>`_,\n\n::\n\n conda install --channel mrbuche ufjc\n \nAlternatively, a branch can be directly installed using\n\n::\n\n pip install git+https://github.com/sandialabs/ufjc.git@<branch-name>\n\nor after cloning a branch and executing ``python setup.py install``.\nThere are also `Docker images <https://hub.docker.com/r/mrbuche/ufjc>`_ available for use.\nIn all of these cases, a valid installation can be tested by running\n\n::\n\n python -m ufjc.tests\n\n***********\nInformation\n***********\n\n- `Contributing <https://ufjc.readthedocs.io/en/latest/CONTRIBUTING.html>`__\n- `Documentation <https://ufjc.readthedocs.io/en/latest/>`__\n- `Examples <https://ufjc.readthedocs.io/en/latest/ufjc.examples.html>`__\n- `License <https://github.com/sandialabs/ufjc/blob/main/LICENSE>`__\n- `Releases <https://github.com/sandialabs/ufjc/releases>`__\n- `Repository <https://github.com/sandialabs/ufjc>`__\n- `Tutorial <https://ufjc.readthedocs.io/en/latest/TUTORIAL.html>`__\n\n********\nCitation\n********\n\n\\M. R. Buche and S. J. Grutzik, ``uFJC``: the Python package for the uFJC single-chain model, `Zenodo (2022) <https://doi.org/10.5281/zenodo.6114263>`_.\n\n\\M. R. Buche, M. N. Silberstein, and S. J. Grutzik, Freely jointed chain models with extensible links, `Physical Review E 106, 024502 (2022) <https://doi.org/10.1103/PhysRevE.106.024502>`_.\n\n*********\nCopyright\n*********\n\nCopyright 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.\n\n..\n Badges ========================================================================\n\n.. |build| image:: https://img.shields.io/github/actions/workflow/status/sandialabs/ufjc/main.yml?branch=main&label=GitHub&logo=github\n :target: https://github.com/sandialabs/ufjc\n\n.. |docs| image:: https://img.shields.io/readthedocs/ufjc?logo=readthedocs&label=Read%20the%20Docs\n :target: https://ufjc.readthedocs.io/en/latest/\n\n.. |codecov| image:: https://img.shields.io/codecov/c/github/sandialabs/ufjc?label=Codecov&logo=codecov\n :target: https://codecov.io/gh/sandialabs/ufjc\n\n.. |coveralls| image:: https://img.shields.io/coveralls/github/sandialabs/ufjc?logo=coveralls&label=Coveralls\n :target: https://coveralls.io/github/sandialabs/ufjc?branch=main\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sandialabs/ufjc?label=Codefactor&logo=codefactor\n :target: https://www.codefactor.io/repository/github/sandialabs/ufjc\n\n.. |pyversions| image:: https://img.shields.io/pypi/pyversions/ufjc.svg?logo=python&logoColor=FBE072&color=4B8BBE&label=Python\n :target: https://pypi.org/project/ufjc/\n\n.. |pypi| image:: https://img.shields.io/pypi/v/ufjc?logo=pypi&logoColor=FBE072&label=PyPI&color=4B8BBE\n :target: https://pypi.org/project/ufjc/\n\n.. |conda| image:: https://img.shields.io/conda/v/mrbuche/ufjc.svg?logo=anaconda&color=3EB049&label=Anaconda\n :target: https://anaconda.org/mrbuche/ufjc/\n\n.. |docker| image:: https://img.shields.io/docker/v/mrbuche/ufjc?color=0db7ed&label=Docker%20Hub&logo=docker&logoColor=0db7ed\n :target: https://hub.docker.com/r/mrbuche/ufjc\n\n.. |license| image:: https://img.shields.io/github/license/sandialabs/ufjc?label=License\n :target: https://github.com/sandialabs/ufjc/blob/main/LICENSE\n\n.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.6114263.svg\n :target: https://doi.org/10.5281/zenodo.6114263\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "The Python package for the uFJC single-chain model.",
"version": "1.3.6",
"split_keywords": [
"ufjc",
"polymers",
"statistical mechanics",
"thermodynamics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "be2909f72a9fca2c8653abe72d650feef48abef60a2b13a599e370a27d281c70",
"md5": "b5996992b60c58f57815009eb758b180",
"sha256": "8e8a330a5cd99b5ff87f5a52e36eb811163ade6f22aecbf25834b9b7c88091b9"
},
"downloads": -1,
"filename": "ufjc-1.3.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b5996992b60c58f57815009eb758b180",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 35380,
"upload_time": "2023-04-06T21:30:48",
"upload_time_iso_8601": "2023-04-06T21:30:48.436217Z",
"url": "https://files.pythonhosted.org/packages/be/29/09f72a9fca2c8653abe72d650feef48abef60a2b13a599e370a27d281c70/ufjc-1.3.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a83e172e36fb97441f25029be08da914b1f688938d107deebf5bdfa62d8e5e22",
"md5": "1832af2530959acf674c826d59415768",
"sha256": "1c2374b41864e8a06dead2a472507ed6acda6b85a6060762d14acff27889edd8"
},
"downloads": -1,
"filename": "ufjc-1.3.6.tar.gz",
"has_sig": false,
"md5_digest": "1832af2530959acf674c826d59415768",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29100,
"upload_time": "2023-04-06T21:30:50",
"upload_time_iso_8601": "2023-04-06T21:30:50.753110Z",
"url": "https://files.pythonhosted.org/packages/a8/3e/172e36fb97441f25029be08da914b1f688938d107deebf5bdfa62d8e5e22/ufjc-1.3.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-06 21:30:50",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "ufjc"
}
JSON