fatpack


Namefatpack JSON
Version 0.7.3 PyPI version JSON
download
home_pagehttps://github.com/gunnstein/fatpack
SummaryFatigue analysis in python
upload_time2022-03-08 20:49:08
maintainer
docs_urlNone
authorGunnstein T. Frøseth
requires_python
licenseISC
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            |logo_img|

=======
fatpack
=======

Python package for fatigue analysis of data series. The package
requires `numpy`.


Installation
------------

Either download the repository to your computer and install, e.g. by **pip**

::

   pip install .


or install directly from the python package index.

::

   pip install fatpack


Usage
-----

The package provides classes and functions for rainflow cycle counting,
defining endurance curves, mean and compressive stress range correction 
and racetrack filtering. The code example below shows how fatigue damage 
can be calculated:

.. code:: python

    import numpy as np
    import fatpack


    # Assume that `y` is the data series, we generate one here
    y = np.random.normal(0., 30., size=10000)

    # Extract the stress ranges by rainflow counting
    S = fatpack.find_rainflow_ranges(y)

    # Determine the fatigue damage, using a trilinear fatigue curve
    # with detail category Sc, Miner's linear damage summation rule.
    Sc = 90.0
    curve = fatpack.TriLinearEnduranceCurve(Sc)
    fatigue_damage = curve.find_miner_sum(S)

An example is included (`example.py <https://github.com/Gunnstein/fatpack/blob/master/example.py>`_) which extracts rainflow cycles,
generates the rainflow matrix and rainflow stress spectrum, see the
figure presented below. The example is a good place to start to get
into the use of the package. 

|example_img|


Additional examples are found in the `examples folder <https://github.com/Gunnstein/fatpack/tree/master/examples>`_.


Support
-------

Please `open an issue <https://github.com/Gunnstein/fatpack/issues/new>`_
for support.


Contributing
------------

Please contribute using `Github Flow
<https://guides.github.com/introduction/flow/>`_.
Create a branch, add commits, and
`open a pull request <https://github.com/Gunnstein/fatpack/compare/>`_.

.. |logo_img| image:: https://github.com/Gunnstein/fatpack/blob/master/fatpack-logo.png
    :target: https://github.com/gunnstein/fatpack/

.. |example_img| image:: https://github.com/Gunnstein/fatpack/blob/master/example.png
    :target: https://github.com/gunnstein/fatpack/



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/gunnstein/fatpack",
    "name": "fatpack",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Gunnstein T. Fr\u00f8seth",
    "author_email": "gunnstein@mailbox.org",
    "download_url": "https://files.pythonhosted.org/packages/ab/ea/88d35f261931e8e31a136af5555b906628675ea63f9c44f9096e6beb4f74/fatpack-0.7.3.tar.gz",
    "platform": null,
    "description": "|logo_img|\n\n=======\nfatpack\n=======\n\nPython package for fatigue analysis of data series. The package\nrequires `numpy`.\n\n\nInstallation\n------------\n\nEither download the repository to your computer and install, e.g. by **pip**\n\n::\n\n   pip install .\n\n\nor install directly from the python package index.\n\n::\n\n   pip install fatpack\n\n\nUsage\n-----\n\nThe package provides classes and functions for rainflow cycle counting,\ndefining endurance curves, mean and compressive stress range correction \nand racetrack filtering. The code example below shows how fatigue damage \ncan be calculated:\n\n.. code:: python\n\n    import numpy as np\n    import fatpack\n\n\n    # Assume that `y` is the data series, we generate one here\n    y = np.random.normal(0., 30., size=10000)\n\n    # Extract the stress ranges by rainflow counting\n    S = fatpack.find_rainflow_ranges(y)\n\n    # Determine the fatigue damage, using a trilinear fatigue curve\n    # with detail category Sc, Miner's linear damage summation rule.\n    Sc = 90.0\n    curve = fatpack.TriLinearEnduranceCurve(Sc)\n    fatigue_damage = curve.find_miner_sum(S)\n\nAn example is included (`example.py <https://github.com/Gunnstein/fatpack/blob/master/example.py>`_) which extracts rainflow cycles,\ngenerates the rainflow matrix and rainflow stress spectrum, see the\nfigure presented below. The example is a good place to start to get\ninto the use of the package. \n\n|example_img|\n\n\nAdditional examples are found in the `examples folder <https://github.com/Gunnstein/fatpack/tree/master/examples>`_.\n\n\nSupport\n-------\n\nPlease `open an issue <https://github.com/Gunnstein/fatpack/issues/new>`_\nfor support.\n\n\nContributing\n------------\n\nPlease contribute using `Github Flow\n<https://guides.github.com/introduction/flow/>`_.\nCreate a branch, add commits, and\n`open a pull request <https://github.com/Gunnstein/fatpack/compare/>`_.\n\n.. |logo_img| image:: https://github.com/Gunnstein/fatpack/blob/master/fatpack-logo.png\n    :target: https://github.com/gunnstein/fatpack/\n\n.. |example_img| image:: https://github.com/Gunnstein/fatpack/blob/master/example.png\n    :target: https://github.com/gunnstein/fatpack/\n\n\n",
    "bugtrack_url": null,
    "license": "ISC",
    "summary": "Fatigue analysis in python",
    "version": "0.7.3",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "9be79cfa2fbeaffe4b8dd648e26af445",
                "sha256": "b0846fc00a9e9f6d38cc6c54597fed6b84e9fc79b42efd7b7a216a199f0059d5"
            },
            "downloads": -1,
            "filename": "fatpack-0.7.3-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9be79cfa2fbeaffe4b8dd648e26af445",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 17988,
            "upload_time": "2022-03-08T20:49:07",
            "upload_time_iso_8601": "2022-03-08T20:49:07.035043Z",
            "url": "https://files.pythonhosted.org/packages/26/88/ae992c6dc471f0a8838ea836984ae699fd89ee2eaee0c628419046b07721/fatpack-0.7.3-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "09726d822d76101d9d6ab2735d7a73b1",
                "sha256": "d152af7dd82a0d482935a385e362f8a9d1509e78cd12317d7bbe0383ea1b3c58"
            },
            "downloads": -1,
            "filename": "fatpack-0.7.3.tar.gz",
            "has_sig": false,
            "md5_digest": "09726d822d76101d9d6ab2735d7a73b1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 15974,
            "upload_time": "2022-03-08T20:49:08",
            "upload_time_iso_8601": "2022-03-08T20:49:08.674624Z",
            "url": "https://files.pythonhosted.org/packages/ab/ea/88d35f261931e8e31a136af5555b906628675ea63f9c44f9096e6beb4f74/fatpack-0.7.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-03-08 20:49:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "gunnstein",
    "github_project": "fatpack",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "tox": true,
    "lcname": "fatpack"
}
        
Elapsed time: 0.01818s