Metadata-Version: 2.1
Name: fracodim
Version: 1.1
Summary: Structural package of the box-counting plot method used in fractal correlation dimension estimation.
Home-page: https://github.com/renangcf/fracodim
Author: Renan Gomes
Author-email: renangcfreitas@gmail.com
License: UNKNOWN
Description: # Fractal Correlation Dimension Estimator
        
        This package estimates the correlation dimension of any N-dimensional dataset.
        
        ## Installation
        
        Use the package manager [pip](https://pip.pypa.io/en/stable/) to install fracodim.
        
        ```bash
        pip install fracodim
        ```
        
        ## Usage
        
        ```python
        import fracodim.correlationDimension as fcd
        
        dataset = [[a0,a1,...,an], [b0,b1,...,bn], ...]
        
        fcd.CorrelationDimension(dataset) # returns a float estimate of the correlation dimension
        ```
        
        The package accepts N-ary datasets, where each point must have n coordinates.
        
        ## Contributing
        
        Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
        
        Please make sure to update tests as appropriate.
        
        ## License
        
        This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
