Installation

Install the package using pip, or download the source code from GitHub.

Prerequisites

• Python 3.10 or higher is required.

• Recommended: a virtual environment (such as virtualenv) to manage dependencies and avoid conflicts.

Install using pip

Install the latest released version from the Python Package Index PyPi:

pip install npycomp

Install a local copy

To install the latest version of NPyComp directly from GitHub, clone the repository and install it in “editable” mode. This allows you to make changes to the source code and see them immediately reflected.

1. Optional: fork the repository .

   If you don’t want to merge your changes with the original repository, you can skip this step.

2. Clone the repository:

   • If you forked the repository, run:

     git clone https://github.com/{GITHUB_USERNAME}/npycomp.git
     

     Replace {GITHUB_USERNAME} with your GitHub username.

   • If you didn’t fork the repository, clone the original repository:

     git clone https://github.com/HRSAndrabi/npycomp.git
     

3. Install NPyComp in editable mode:

   pip install --editable .
   

This will install NPyComp along with all necessary dependencies.