Installation#
Prerequisites#
If running MahaUtils on a Linux system, ensure that libGL is installed. For example, to install this package on Ubuntu, run:
$ sudo apt install libgl1
pip#
Stable Version#
MahaUtils has been packaged through PyPI, so the easiest way to install the latest package release is through pip:
$ pip install mahautils
C:\>pip install mahautils
As with any Python project, it may be useful to consider setting up a virtual environment and installing packages in it.
Development Version#
To use the latest MahaUtils features prior to their release on PyPI, you can install the package directly from the project’s GitHub page using:
$ pip install git+https://github.com/nathan-hess/maha-research-utils.git@main
C:\>pip install git+https://github.com/nathan-hess/maha-research-utils.git@main
Source Code#
Alternatively, if you prefer to work from the source code directly, you can download
the source code using Git, and then add the download directory to your PYTHONPATH
environment variable so that the MahaUtils can be imported from scripts
or Python terminals.
Note
Some functionality, such as command-line utilities, will not be available if setting up MahaUtils using this method.
First, clone the source repository to a location of your choice:
$ git clone https://github.com/nathan-hess/maha-research-utils.git
C:\>git clone https://github.com/nathan-hess/maha-research-utils.git
Note that it is not recommended that you download the source code to
your C:\ directory; this is merely shown as a general example.
Then, add the root directory of the repository to your PYTHONPATH environment
variable:
$ export PYTHONPATH="$PYTHONPATH:$(pwd)/maha-research-utils"
C:\>set PYTHONPATH=%PYTHONPATH%;%CD%\maha-research-utils
Finally, make sure to install required dependencies through pip:
$ pip install -r maha-research-utils/requirements.txt
C:\>pip install -r maha-research-utils\requirements.txt