Metadata-Version: 1.2
Name: cmomy
Version: 0.0.7.1
Summary: Central (co)moment calculation/manipulation
Home-page: https://github.com/wpk-nist-gov/cmomy
Author: William P. Krekelberg
Author-email: wpk@nist.gov
License: NIST license
Description: =====
        cmomy
        =====
        
        
        .. image:: https://img.shields.io/pypi/v/cmomy.svg
                :target: https://pypi.python.org/pypi/cmomy
        
        .. image:: https://img.shields.io/travis/wpk-nist-gov/cmomy.svg
                :target: https://travis-ci.com/wpk-nist-gov/cmomy
        
        ..
           .. image:: https://readthedocs.org/projects/cmomy/badge/?version=latest
                   :target: https://cmomy.readthedocs.io/en/latest/?badge=latest
                   :alt: Documentation Status
        
        
        Central (co)moment calculation/manipulation
        
        
        * Free software: NIST license
        * Documentation: https://cmomy.readthedocs.io.
        
        
        Features
        --------
        
        * Fast calculation of central moments and central co-moments with weights
        * Support for scalor or vector inputs
        * numpy and xarray api's
        
        
        Note on caching
        ---------------
        
        This code makes extensive use of the numba python package. This uses a
        jit compiler to speed up vital code sections. This means that the first
        time a funciton called, it has to compile the underlying code. However,
        caching has been implemented. Therefore, the very first time you run a
        function, it may be slow. But all subsequent uses (including other
        sessions) will be already compiled.
        
        Testing
        -------
        
        Tests are packaged with the distribution intentionally. To test code
        run:
        
        .. code:: bash
        
           pytest -x -v --pyargs cmomy
        
        By running the tests once, you create a cache of the numba code for most
        cases. The first time you run the tests, it will take a while (about 1.5
        min on my machine). However, subsequent runs will be much faster (about
        3 seconds on my machine).
        
        Credits
        -------
        
        This package was created with Cookiecutter_ and the `wpk-nist-gov/cookiecutter-pypackage`_ Project template forked from `audreyr/cookiecutter-pypackage`_.
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`wpk-nist-gov/cookiecutter-pypackage`: https://github.com/wpk-nist-gov/cookiecutter-pypackage
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        =======
        History
        =======
        
        0.0.5 (2020-12-30)
        ------------------
        
        * First release on PyPI.
        
        This software was developed by employees of the National Institute of Standards
        and Technology (NIST), an agency of the Federal Government. Pursuant to title 17
        United States Code Section 105, works of NIST employees are not subject to
        copyright protection in the United States and are considered to be in the public
        domain. Permission to freely use, copy, modify, and distribute this software and
        its documentation without fee is hereby granted, provided that this notice and
        disclaimer of warranty appears in all copies.
        
        THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
        EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
        THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
        MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
        INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
        SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
        SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
        INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, OR
        IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
        CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
        PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
        OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
        
        Distributions of NIST software should also include copyright and licensing
        statements of any third-party software that are legally bundled with the code in
        compliance with the conditions of those licenses.
        
Keywords: cmomy
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: Public Domain
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.6
