matpak 2.1.0

Matrix Utilization Python Package

MatPak

Matrix Utilization Python Package.

Files structure

src/: source codes of library lives in here.

src/matpak/: MatPak package files stored in this directory.

tests/: MatPak package unit tests are located here.

Usage

First of all, MatPak should be installed via your python package manager (e.g, pip):

pip install matpak

Then by importing matpak package in your application files, you can use MatPak's public API functions:

import matpak

def main():
    # import custom matrix from file
    foo_mat = matpak.imp_mat_file("./foo_mat.txt")
    
if __name__ == "__main__":
    main()

Test

To execute unit tests, from root dir:

python -m unittest discover -s tests -p "*_test.py"

on successful test:

..................
----------------------------------------------------------------------
Ran 18 tests in 0.048s

OK

Examples

tests/ directory contains tests that are also best examples to inspire from. all public APIs tested and all names (function names, variable name, etc...) are clear to find out what is going on.

Contribution

Feel free to fork, modify and open a pull request in this repository. Thanks for your contribution.