Skip to main content

Generalized Numerical P Systems simulator package

Project description

GNPS Project

GNPS (Generalized Numerical P Systems) is a Python package for parsing and simulating numerical P systems, and for exporting them to generated code.

Current Capabilities

  • Python simulation of standalone and import-composed GNPS YAML systems
  • Python source export through gnps-transform -t python, including import-composed systems as a single generated file
  • Verilog/SystemVerilog export through gnps-transform -t verilog
  • Optional import/composition metadata for Verilog generation

CLI

Simulator

python -m gnps <gnps_file.yaml> [input.csv] [output.csv] [options]

Options:

  • -c, --compute_mode: run in continuous compute mode
  • -s, --steps N: number of steps to run
  • --csv: emit CSV in continuous mode

The simulator supports standalone GNPS YAML and import-composed GNPS systems. Files using externals still fail clearly in the Python runtime.

Transformer

gnps-transform <gnps_file.yaml> -t {python,verilog} [options]

Options:

  • -o, --output-dir DIR: output directory
  • --output-suffix SUFFIX: suffix inserted before the generated file extension
  • --import-path DIR: extra import search path, may be repeated
  • --import-paths LIST: path-separated import search list
  • -v, --verbose: verbose logging

Import resolution order:

  1. relative to the importing YAML file
  2. --import-path / --import-paths directories in the order provided

YAML Schema

Standalone legacy files still work:

cells:
  - id: 1
    contents:
      - x = 0
      - y = 1
    input: [x]
    output: [y]

rules:
  - x + 1 -> y

Verilog/SystemVerilog-oriented extensions are optional:

module:
  name: controller_top
  zero_reset_mode: false
  real_encoding:
    kind: fixed_point
    signed: true
    width: 32
    frac_bits: 16
  clock:
    name: clk
  reset:
    name: rst
    active_high: true
  top_ports:
    - name: uart_rx
      dir: input
      kind: logic
      width: 1
      signed: false

constants:
  THRESHOLD: 5

aliases:
  sensed: sensor0.level

imports:
  - module: sensor.yaml
    as: sensor0
    connections:
      raw: sample

externals:
  - header: uart.header.yaml
    as: uart0
    connections:
      clk: top.clk
      rst: top.rst
      rx: top.uart_rx

cells:
  - id: 1
    contents:
      - sample = 0
      - alarm = 0
    output: [alarm]

rules:
  - sensed > THRESHOLD && uart0.rx_valid == 1 | uart0.rx_data + 1 -> alarm

Qualified references supported by the parser:

  • local variable: x
  • imported GNPS IO: sensor0.level
  • external port: uart0.rx_valid
  • top-level signal: top.uart_rx, top.clk, top.rst

Defaults

If module is absent, the effective defaults are:

  • module name: source filename stem
  • zero_reset_mode: false
  • real_encoding.kind: fixed_point
  • real_encoding.signed: true
  • real_encoding.width: 32
  • real_encoding.frac_bits: 16
  • clock name: clk
  • reset name: rst
  • reset polarity: active high
  • top ports: none

If constants, aliases, imports, or externals are absent, they default to empty.

These defaults are also documented in rules.md.

Generated RTL

The verilog backend emits SystemVerilog-style RTL:

  • file extension: .sv
  • wraps each generated module with `default_nettype none and restores `default_nettype wire afterward
  • module parameters in the module header
  • always_comb for next-state logic
  • always_ff for sequential updates
  • fixed-point values stay as integer literals in the emitted RTL, wrapped in generated module-local localparam aliases such as _VAL_1_0
  • generated fixed-point state, helper signatures, and literals now follow module.real_encoding.signed instead of always being emitted as signed values
  • boundary conversions use generated integer-only helper functions rather than real-based helpers
  • if a GNPS input/output has the same name as a declared top_port, the generated RTL automatically converts between the module-local fixed-point encoding and the declared top-port integer/logic format at the module boundary
  • plain variable names such as sample or alarm refer to the local GNPS variable, while top.sample refers to the raw top-level signal before or after that boundary conversion
  • fixed-point to integer top-port conversion truncates toward zero
  • generated literal aliases are documented with comments showing the original source values and fixed-point format

Supported expression subset:

  • constants
  • local variables
  • qualified references
  • addition and subtraction
  • unary minus
  • constant multiplication and constant division
  • boolean comparisons
  • boolean &&, ||, !

Rejected constructs:

  • generic function calls
  • variable-by-variable multiplication
  • non-constant division
  • arrays

Each GNPS module uses its own real_encoding. Boundary conversions are inserted automatically for imported GNPS IO and external ports. In the Verilog backend, consumed variables are reset to zero explicitly before productions are accumulated.

Examples

See src/examples/ for:

  • standalone legacy-style YAML
  • import-only Python/Verilog composition
  • FPGA-oriented examples under src/examples/fpga/, including blink.yaml and blink_uart.yaml
  • imported multicell Verilog composition
  • external UART header and controller top module examples

Notes

  • Top-level name and description are treated as metadata and ignored by Verilog generation.
  • Python composition currently supports imports only.
  • externals are not yet supported by the Python backend or runtime simulator.
  • Declaring a variable in output only exposes it at the module boundary; it does not implicitly consume or reset that variable each step. If an output should behave like a per-step pulse/value rather than accumulated state, add an explicit consume/reset rule for it.
  • module.zero_reset_mode: true changes only that module’s local variables: they are cleared to zero at the start of every step before productions are accumulated. Imported modules keep their own mode independently.
  • Detailed behavior and schema rules live in rules.md.

Example:

cells:
  - id: 1
    contents:
      - alarm = 0
    output: [alarm]

rules:
  # Persistent output/state: alarm keeps its previous value unless consumed
  - sensor0.level > 2 | 1 -> alarm
cells:
  - id: 1
    contents:
      - alarm = 0
    output: [alarm]

rules:
  # Per-step output: first produce the value you want
  - sensor0.level > 2 | 1 -> alarm
  # Then consume/reset alarm each step so it does not accumulate
  - alarm * 0 -> alarm

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

gnps-0.3.3.tar.gz (55.1 kB view details)

Uploaded Source

Built Distribution

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

gnps-0.3.3-py3-none-any.whl (38.0 kB view details)

Uploaded Python 3

File details

Details for the file gnps-0.3.3.tar.gz.

File metadata

  • Download URL: gnps-0.3.3.tar.gz
  • Upload date:
  • Size: 55.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.25.9 CPython/3.12.11 Linux/6.12.74+deb13+1-amd64

File hashes

Hashes for gnps-0.3.3.tar.gz
Algorithm Hash digest
SHA256 3dd32f494b6d290dcac9daedd28d33b712b4f64e123dfda0564d89ed0bfda409
MD5 e9ab0a1a9e8008d06e0ea579e444cc71
BLAKE2b-256 cd1834068ca6d98be6e2545f1e693f5616ab4ea7e4ddbaf2345fc1a623ee628f

See more details on using hashes here.

File details

Details for the file gnps-0.3.3-py3-none-any.whl.

File metadata

  • Download URL: gnps-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 38.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.25.9 CPython/3.12.11 Linux/6.12.74+deb13+1-amd64

File hashes

Hashes for gnps-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8c071f305f5c5ad87bdcbabbf59ab0caee6f595e46d7edd213555ed5b18706f5
MD5 b7090296685bb68cdef3557ce115d7ee
BLAKE2b-256 535bb5f597105b7b52b49351b7aa529432eca035184c8742e3bcec7068049558

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