Installation

Python

BoolForge is developed for Python 3.10+ and is not compatible with prior versions of Python.

It is recommended to install the package using pip. If you do not already have pip installed, run:

C:> py -m ensurepip --upgrade

To install BoolForge with pip, run:

C:> py -m pip install boolforge

You should now be able to import BoolForge:

C:> py
>>> import boolforge

To remove BoolForge using pip, run:

C:> py -m pip uninstall boolforge

It is recommended to install the package using pip. If you do not already have pip installed, run:

$ python -m ensurepip --upgrade

To install BoolForge with pip, run:

$ python -m pip install boolforge

You should now be able to import BoolForge:

$ python
>>> import boolforge

To remove BoolForge using pip, run:

$ python -m pip uninstall boolforge

BoolForge is fully usable with its core dependencies, but some features rely on optional packages that can be installed via extras.

Some internal routines are automatically accelerated if numba is available.

To enable numba acceleration:

pip install boolforge[speed]

When numba is not installed, BoolForge transparently falls back to pure-Python implementations.

Plotting of wiring diagrams and network structure requires matplotlib.

To enable plotting:

pip install boolforge[plot]

Some methods interface with the CANA package for advanced canalization measures.

To enable CANA-based functionality:

pip install boolforge[cana]

Symbolic representations and logical expression minimization rely on PyEDA.

To enable symbolic functionality:

pip install boolforge[symbolic]

The retrival and loading of hundreds of published biological Boolean network models relies on the requests package for web access.

To enable biological model retrieval:

pip install boolforge[bio]

To install BoolForge with all optional dependencies:

pip install boolforge[all]

BoolForge supports import and export of Boolean network representations used by other software packages.

In particular, BoolForge supports the BNet format commonly used by pyboolnet, without requiring pyboolnet itself to be installed.

Boolforge also supports converstion to and from the format used by CANA.