Skip to main content

A Python port of Fluid Construction Grammar

Project description

PyFCG

A Python interface to FCG and Babel, built on FCG Go.

Installation

The Python integration of FCG (aka PyFCG) is distributed as a pip-installable package. To install this package from PyPI, run the following command.

$ pip install pyfcg

Use

Once pip-installed, PyFCG can readily be imported as a module into Python programs. It is customary to define fcg as an alias for the PyFCG module, so that all functionality is available within the fcg namespace (functions and variables are thereby prefixed with fcg.)

You initialise PyFCG as follows:

>>> import pyfcg as fcg
>>> fcg.init()

Many FCG functions depend on the fcg-go precompiled binary, which you loaded (or download if necessary) by calling the init() function. On macOS, you will need to accept opening the application bundle by clicking "open" in the popup window.

Example: Creating an FCG Agent

The Agent class will usually be your main entry point. The idea is that an agent has a grammar (of type Grammar), which in turn holds constructions (of type Construction). In PyFCG, a grammar will always be tied to an agent. Upon creation, an agent is automatically initialised with an empty grammar, i.e. a grammar that holds zero constructions.

>>> demo_agent = fcg.Agent()

>>> demo_agent
<Agent: agent (id: agent-42) ~ 0 constructions>

>>> demo_agent.grammar.size()
0

Walkthrough Tutorials

A more in-depth showcase of PyFCG's functionalities can be found in the following interactive notebooks. Each of them walks you through the process of integrating PyFCG in a typical use case of FCG.

Documentation

The tecnical documentation of PyFCG is available at Read the Docs.

How to Cite

Van Eecke, P., & Beuls, K. (2025). PyFCG: Fluid Construction Grammar in Python. arXiv preprint.

@article{vaneecke2025pyfcg,
    author = {Paul {Van Eecke} and Katrien Beuls},
    title = {PyFCG: Fluid Construction Grammar in Python},
    year = {2025},
    journal = {arXiv preprint arXiv:},
    doi = {10.48550/arXiv.2505.12920},
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyfcg-0.1b6.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyfcg-0.1b6-py3-none-any.whl (15.2 kB view details)

Uploaded Python 3

File details

Details for the file pyfcg-0.1b6.tar.gz.

File metadata

  • Download URL: pyfcg-0.1b6.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for pyfcg-0.1b6.tar.gz
Algorithm Hash digest
SHA256 5d8e233e9d76977fef324ac83af52e766a84bcb80c123beac575e22fc9075a7f
MD5 589d7c4186090f21a6c3c92c2618ecb3
BLAKE2b-256 25bd2b84be321a79c923fcc67269923088a3820c0f5fe81009dcdf80a6ede809

See more details on using hashes here.

File details

Details for the file pyfcg-0.1b6-py3-none-any.whl.

File metadata

  • Download URL: pyfcg-0.1b6-py3-none-any.whl
  • Upload date:
  • Size: 15.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for pyfcg-0.1b6-py3-none-any.whl
Algorithm Hash digest
SHA256 5041d3ea9fedab74fac82c41d832cda45f15893404bf9bfa0e8253a86eb6b554
MD5 eb9cde0705e2374481d07f06864502dd
BLAKE2b-256 d7f423d831f1a8a4a23c828bb0193849f70403995fb2bf2a7caa6cfa26afa250

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page