Metadata-Version: 2.1
Name: cmomy
Version: 0.0.2
Summary: Central (co)moment calculation
Home-page: https://github.com/wpk-nist-gov/cmomy
Author: William Krekelberg
Author-email: wpk@nist.gov
License: NIST license https://www.nist.gov/director/licensing
Description: # Package for analyzing central moments
        
        For example usage, look at [example usage](examples/example_usage.ipynb)
        
        # INSTALLATION
        
        ## Install needed packages
        
        If using conda, then
        
        ``` {.bash org-language="sh"}
        conda install numpy xarray numba 
        ```
        
        ## From source
        
        ``` {.bash org-language="sh"}
        cd directory/path
        git clone https://github.com/wpk-nist-gov/cmomy.git
        
        # full install (note that versioning is iffy.  -I forces reinstall)
        pip install -I -U .
        
        # for editable
        pip install -e .
        ```
        
        To run tests:
        
        ``` {.bash org-language="sh"}
        pytest -v
        ```
        
        Note that tests are a bit slow (about 1.5 min). This is due to numba jit
        compiler having to compile all underlying functions for all cases.
        
        ## pip install
        
        ``` {.bash org-language="sh"}
        pip install -I -U git+https://github.com/wpk-nist-gov/cmomy.git@develop
        ```
        
        # 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.
        
Keywords: data analysis
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
