Installation Guide

Table of Contents

• C++ Executable File
• Python Library
  • Installation from Source
  • Installation From PyPI (upcoming)

C++ Executable File

To install the executable version of NEFFy:

1. Clone the repository:

   git clone https://github.com/Maryam-Haghani/Neffy.git

2. Navigate to the project directory:

   cd Neffy

3. Compile the code using a C++ compiler that supports C++17 or a newer version, through the provided Makefile in the repository.

   make

   • If the make command is not available on your operating system, refer to the Help page.

Once the compilation is complete, you can run the program via the command line.
This package is cross-platform and works on Linux, Windows, and macOS without requiring additional compilation.

---

Python Library

Installation from Source

To install the library from the source:

1. Clone the repository:

   git clone https://github.com/Maryam-Haghani/Neffy.git

2. Navigate to the project directory:

   cd Neffy

3. Ensure you have setuptools and wheel installed:

   pip install setuptools wheel

4. Build the source distribution and wheel:

   python setup.py sdist bdist_wheel

5. Install the package from the root directory of the project:

   pip install .

   • Alternatively, you can install the package directly from the built wheel file (in the dist directory):

     pip install dist/neffy-0.1-py3-none-any.whl

Installation from PyPI (upcoming)

Our Python library will soon be available on PyPI. This will make it easier for you to install and manage the library using pip.
To install the package from PyPI:

pip install neffy

---

For further assistance or inquiries, please contact the developer or create an issue in the GitHub repository.