Installation¶
Virtual environment¶
Set up your Python3 virtual environment to safely install the dependencies. For details, refer to this guide for venv or this guide if you prefer Conda. For Spyder users, specify the path to the the environment interpreter will get you started.
On MacOS/Linux:
python3 -m venv myenv
source myenv/bin/activate
Attention
Requirement:
It requires Python >=3.11
Install using pip¶
PyUncertainNumber can be installed from PyPI. Upon activation of your virtual environment, use your terminal:
pip install pyuncertainnumber
Verify the installation using the snippet below:
python3 -c "import pyuncertainnumber as pun; print(pun.norm([0,12],[1,4]))"
Dependencies¶
Refer to the requirements.txt file from the GitHub repository to see the requirements. Note these will be automatically installed during the pip install process of the package. There is no need to manually install them.
Contributions¶
If you feel like make contributions to the developement, which is highly encouraged, please have a fork on the GitHub repository, git clone it, change directory to the project root directory and install it in editable mode. Once you are happy, pull request your changes.
pip install -e .
Questions¶
Raise an issue on the GitHub page if you run into problems. Note that this libary is under active develpment, so APIs will change across different versions.