ImtiazGermain Documentation

Installation

Requirements

ImtiazGermain requires the following:

  • Python 3.6+

  • Sympy

  • Rust (no need for Python or Sympy)

Installation with pip

ImtiazGermain can be installed using pip:

$ pip install ImtiazGermain

Installation from source

To install ImtiazGermain from source, follow these steps:

  1. Clone the repository:

    $ git clone https://github.com/AitSad/ImtiazGermain.git

  2. Navigate to the repository directory:

    $ cd ImtiazGermain

  3. Install the package:

    $ pip install .

    This will install the package and its dependencies.

    Alternatively, you can install the package in development mode:

    $ pip install -e .

    This will install the package in editable mode, so changes you make to the code will be immediately reflected.

    Note: You may need to use sudo to install the package globally on your system.

Installation from cargo

You can use the cargo module in rust, to load ImtiazGermain as a crate as following:

[dependencies]
ImtiazGermain = "0.1.1"

Upgrade

To upgrade ImtiazGermain to the latest version, use pip:

$ pip install --upgrade ImtiazGermain

Contributing to ImtiazGermain

Thank you for your interest in contributing to ImtiazGermain! We welcome contributions from everyone.

Before you start, please read our Code of Conduct to ensure that you understand our expectations for behavior.

How to Contribute

Here are the steps to follow to contribute to ImtiazGermain:

  1. Fork the ImtiazGermain repository on GitHub.

  2. Create a new branch for your contribution.

  3. Make your changes to the code.

  4. Write tests for your changes.

  5. Ensure that all tests pass by running pytest in the root directory.

  6. Update the documentation to reflect your changes.

  7. Submit a pull request.

Please keep in mind that we may ask you to make changes to your pull request before we merge it. We may also ask you to add more tests or documentation.

Reporting Issues

If you encounter a problem with ImtiazGermain or have a feature request, please open an issue on our GitHub issue tracker.

In your issue, please provide as much detail as possible about the problem or feature request. Include the version of ImtiazGermain you are using, any relevant code samples or error messages, and steps to reproduce the problem.

Code of Conduct

Please note that this project follows a Code of Conduct. By participating in this project you agree to abide by its terms.

API Reference

Indices and tables