neolinearalgebra 0.2.4

NEO Linear Algebra package for Matrix Manipulation.

NEO Linear Algebra

Author: Sajid Al Sanai

License: MIT License

Version: 0.2.4

Article: NEO Linear Algebra for Python

PyPi.org: neolinearalgebra 0.2.4

Table of Contents

1. Motivation
2. Installation
3. Build
4. Files
5. Unit Testing
6. Usage
7. Documentation

1. Motivation

NEO Linear Algebra is a lightweight Python package designed for Matrix operations in Linear Algebra.

I was inspired to program this from scratch as part of a light review of the absolute fundamentals of Linear Algebra and my own first attempt at the development of a Python package for open source. I was also inspired by rewatching The Matrix quadrilogy.

2. Installation

This project consists of a directory for a singular Matrix class file.

You may install this package locally on your machine or download through the Python pip package manager.

To download this repository and install the package locally on your machine, use the following bash code in a UNIX-based environment:

git clone https://github.com/sajidsarker/neolinearalgebra.git
cd ./neolinearalgebra/
python3 -m pip install --upgrade pip
python3 -m pip install .

To download this repository and upgrade the package locally on your machine, use the following bash code in a UNIX-based environment:

git clone https://github.com/sajidsarker/neolinearalgebra.git
cd ./neolinearalgebra/
python3 -m pip install --upgrade pip
python3 -m pip install --upgrade .

To uninstall the package locally on your machine, navigate to the repository directory in your terminal use the following bash code in a UNIX-based environment:

python3 -m pip uninstall .
cd ../ && rm -rf ./neolinearalgebra

To install this package through the Python pip package manager, use the following bash code in a UNIX-based environment:

python3 -m pip install --upgrade pip
python3 -m pip install neolinearalgebra

To upgrade this package through the Python pip package manager, use the following bash code in a UNIX-based environment:

python3 -m pip install --upgrade pip
python3 -m pip install --upgrade neolinearalgebra

To uninstall this package through the Python pip package manager, use the following bash code in a UNIX-based environment:

python3 -m pip uninstall neolinearalgebra

3. Build

To download this repository and build the package locally on your machine, use the following bash code in a UNIX-based environment:

git clone https://github.com/sajidsarker/neolinearalgebra.git
cd ./neolinearalgebra/
python3 -m pip build . --wheel

4. Files

The directory structure for this repository is detailed below:

/
├── Documentation/
│   ├── neolinearalgebra/
│   │   └── Matrix.html
│   ├── Documentation.html
│   ├── neolinearalgebra.html
│   └── search.js
├── src/
│   └── neolinearalgebra/
│       ├── Matrix.py
│       └── __init__.py
├── tests/
│   └── test.py
├── .gitignore
├── LICENSE.txt
├── README.md
├── pyproject.toml
├── setup.cfg
└── setup.py

Setup and configuration files for package installation is in the root . directory. The contents of the package is stored in ./neolinearalgebra/. The singular class is Matrix.

5. Unit Testing

The aforementioned file test.py for performing unit testing is included in the main directory of the repository. You may append the program with additional functions for unit testing Matrix.py.

Please only perform unit testing after you have upgraded your version of the package locally during open source development.

To perform unit testing, use the following bash code in a UNIX-based environment:

cd ./neolinearalgebra/tests/
python3 -v test.py

or

cd ./neolinearalgebra/tests/
chmod +x test.py
./test.py -v

6. Usage

To import NEO Linear Algebra into your Python project, use the following import declaration at the start of your program code:

from neolinearalgebra import Matrix

7. Documentation

Docstrings highlight the behaviour of class attributes and class methods within files in this repository. A comprehensive reference on class attributes and methods are present in the ./Documentation folder.

A version of the same documentation is hosted online on my blog.

For information on the motivation behind this project, you may consult my blog post for an overview.