Metadata-Version: 2.1
Name: cnspy_numpy_utils
Version: 0.2.0
Summary: Some utility functions for numpy data types
Home-page: https://github.com/aau-cns/cnspy_numpy_utils/
Author: Roland Jung
Author-email: roland.jung@aau.at
Project-URL: Bug Tracker, https://github.com/aau-cns/cnspy_numpy_utils/issues
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENCE
Requires-Dist: numpy

# cnspy_numpy_utils Package

A package holding useful scripts based on the numpy package, that cannot be associated to any other (dangling code, that is used in different places). 

Most important functions:
1. [tri_vec_to_mat(tri_vec, n=None)](./cnspy_numpy_utils/matrix_conversions.py)
1. [mat_to_tri_vec(P)](./cnspy_numpy_utils/matrix_conversions.py)
1. [accumulated_distance(p_vec)](./cnspy_numpy_utils/accumulated_distance.py)
1. [total_distance(p_vec)](./cnspy_numpy_utils/accumulated_distance.py)
1. [numpy_statistics(vNumpy](./cnspy_numpy_utils/numpy_statistics.py)
1. [print_statistics(metrics](./cnspy_numpy_utils/numpy_statistics.py)

## Installation

Install the current code base from GitHub and pip install a link to that cloned copy
```
git clone https://github.com/aau-cns/cnspy_numpy_utils.git
cd cnspy_numpy_utils
pip install -e .
```
or the [official package](https://pypi.org/project/cnspy-numpy-utils/) via
```commandline
pip install cnspy-numpy-utils
```

## Dependencies

It is part of the [cnspy eco-system](hhttps://github.com/aau-cns/cnspy_eco_system_test) of the [cns-github](https://github.com/aau-cns) group.  

* [numpy]()



## License

Software License Agreement (GNU GPLv3  License), refer to the LICENSE file.

*Sharing is caring!* - [Roland Jung](https://github.com/jungr-ait)  

