Installation

Installation guide for pykleene - A Python library for automata theory

To get started with pykleene, follow these simple steps to set up the library in your Python environment.

Prerequisites

Before installing pykleene, make sure you have the following:

  • Python 3.8 or higher installed on your machine
  • pip package manager (usually comes with Python)
  • Virtual environment (recommended)
  • Graphviz (for visualizing automata)

Remember:

pykleene requires Python 3.8+ due to its dependency on modern Python features. Using older versions may result in compatibility issues or unexpected behavior.

Installation Steps

  1. Install Graphviz:
    Before proceeding with the installation of pykleene, make sure you have Graphviz installed on your system. Graphviz is required for visualizing automata.
    You can download and install Graphviz from Graphviz's official website.

  2. Create and activate a virtual environment (recommended):

python -m venv pykleene-env
source pykleene-env/bin/activate  # On Windows: pykleene-env\Scripts\activate
  1. Install pykleene using pip:
pip install pykleene
  1. For development installation, clone the repository:
git clone https://github.com/your-repo/pykleene.git
cd pykleene
pip install -e .

Additional Information

For more detailed instructions and troubleshooting tips, refer to our documentation.

Common installation issues and solutions:

  • If you encounter permission errors, try using pip install --user pykleene
  • For system-wide installation (not recommended), use sudo pip install pykleene
  • To upgrade an existing installation: pip install --upgrade pykleene