Skip to content

wedkarz02/xamai

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

96 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

XAMAI Academic Math and Algorithm Implementation

Please note that this is a work in progress project that may still contain bugs and missing features. Detailed description not available yet.

The source for this project is avaliable here.

Download

To download XAMAI repository run this command:

git clone https://github.com/wedkarz02/xamai.git

or use the "Download ZIP" option from the GitHub page.

Usage

The easiest way of setting up XAMAI is downloading the repository directly into the project directory. After that it becomes available as a regular package and can be imported with:

import xamai

If you don't want to download the package into your project directory please read the following instructions.

To use XAMAI properly you need to insert an absolute path of the parent directory of XAMAI to sys.path of your script. The way of doing this highly depends on your project setup and XAMAI package location.
Consider this example:

projects/
|
|---- test_project/
|     |
|     |---- main.py
|
|---- xamai/

In this example the parent directory of xamai/ is projects/, so in order to use XAMAI in main.py you would need to insert an absolute path to projects/ in sys.path of the main.py file.
Since test_project/ and xamai/ share the same parent directory the easiest way of doing it would be writing this code snippet in main.py :

import sys
import pathlib

package_path = str(pathlib.Path(__file__).resolve().parents[1])
sys.path.insert(0, package_path)

# At this point XAMAI is available
# and can be imported as a normal package.
import xamai

For more information about the python package system I highly recommend reading this article by Chris Yeh as well as the python documentation.

About

XAMAI Academic Math and Algorithm Implementation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages