Package: neolinearalgebra
NEO Linear AlgebraAuthor:Sajid Al SanaiLicense:MIT LicenseVersion:0.2.4Article:NEO Linear Algebra for PythonPyPi.org:neolinearalgebra 0.2.4Table of ContentsMotivationInstallationBuildFilesUnit TestingUsageDocumentation1. MotivationNEO Linear Algebrais 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. InstallationThis project consists of a directory for a singularMatrixclass file.You may install this package locally on your machine or download through the Python pip package manager.To download this repository andinstallthe package locally on your machine, use the following bash code in a UNIX-based environment:gitclonehttps://github.com/sajidsarker/neolinearalgebra.gitcd./neolinearalgebra/
python3-mpipinstall--upgradepip
python3-mpipinstall.To download this repository andupgradethe package locally on your machine, use the following bash code in a UNIX-based environment:gitclonehttps://github.com/sajidsarker/neolinearalgebra.gitcd./neolinearalgebra/
python3-mpipinstall--upgradepip
python3-mpipinstall--upgrade.Touninstallthe package locally on your machine, navigate to the repository directory in your terminal use the following bash code in a UNIX-based environment:python3-mpipuninstall.cd../&&rm-rf./neolinearalgebraToinstallthis package through the Python pip package manager, use the following bash code in a UNIX-based environment:python3-mpipinstall--upgradepip
python3-mpipinstallneolinearalgebraToupgradethis package through the Python pip package manager, use the following bash code in a UNIX-based environment:python3-mpipinstall--upgradepip
python3-mpipinstall--upgradeneolinearalgebraTouninstallthis package through the Python pip package manager, use the following bash code in a UNIX-based environment:python3-mpipuninstallneolinearalgebra3. BuildTo download this repository andbuildthe package locally on your machine, use the following bash code in a UNIX-based environment:gitclonehttps://github.com/sajidsarker/neolinearalgebra.gitcd./neolinearalgebra/
python3-mpipbuild.--wheel4. FilesThe 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.pySetup and configuration files for package installation is in the root.directory. The contents of the package is stored in./neolinearalgebra/. The singular class isMatrix.5. Unit TestingThe aforementioned filetest.pyfor performing unit testing is included in the main directory of the repository. You may append the program with additional functions for unit testingMatrix.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-vtest.pyorcd./neolinearalgebra/tests/
chmod+xtest.py
./test.py-v6. UsageTo importNEO Linear Algebrainto your Python project, use the followingimportdeclaration at the start of your program code:fromneolinearalgebraimportMatrix7. DocumentationDocstrings 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./Documentationfolder.A version of the same documentation is hosted online on myblog.For information on the motivation behind this project, you may consult myblog postfor an overview.