Skip to main content

Cogniflow signal processing step package (FIFO windowing and averages) implemented in C++.

Project description

cf.basic.signal StepPackage

Signal-processing steps packaged for Cogniflow (FIFO buffer and statistical averages).

Note: Dev/demo/benchmark steps (InlineSource, OpcuaPhSource, OmpReductionStep, BudgetAwareStep) have moved to cf-basic-dev. This package now contains only core signal-processing steps.

Steps

Step Description
cfbs:FifoWindowBufferStep Sliding FIFO window buffer
cfbs:AverageStep Arithmetic / geometric / harmonic mean with standard error

Files

  • steps.nq - single manifest (package metadata + ontology + implementation bindings)
  • src/cf_basic_signal/cpp/steps.cpp - C++ implementations (plugin backend)
  • examples/golden_fifo_avg.json - minimal signal pipeline (InlineSource from cf-basic-dev -> FIFO -> Average) (legacy)

Pipeline backend plugin

The package registers a C++ plugin artifact described in steps.nq:

  • C++ ops (impl="cpp"): fifo_window_buffer, average (registered via capsule register_cpp_op)
  • No Python fallbacks; the C++ extension is required for pipeline_backend usage

Plugin metadata (artifact path, list/resolve symbols, certification) is stored under the cf:PluginArtifact node in steps.nq.

Quick check

  1. Install package (editable or wheel) so the cogniflow.steps entry point exposes steps.nq.

  2. Ingest step packages via cf_ontology and verify:

import os
from cf_ontology import ingest_installed_step_packages, OntologyManager

os.environ["CF_ENABLE_STEP_PACKAGES"] = "1"
ingest_installed_step_packages()
om = OntologyManager()
assert om.get_step_info("cfbs:FifoWindowBufferStep")
assert om.get_step_info("cfbs:AverageStep")
  1. (Legacy) Run the example pipeline via your runner. Expected output:
    • golden_fifo_avg: window [4,5,6], mean 5.0, small SE.

Published distribution name:

pip install cf-basic-signal

Native build prerequisites

cf_basic_signal is built with scikit-build-core and CMake and requires the published SDK package at build time:

  • CPython 3.13
  • CMake on PATH
  • a Windows C++ toolchain compatible with that CMake installation
  • access to cf-pipeline-sdk from the package index

The package-local CMake currently generates the signature header through python -m cogniflow_pipeline_sdk.siggen and copies the built plugin artifact into the installed package's bin/ directory.

Publishing

cf_basic_signal is published with the dedicated Windows workflow:

  • Workflow: .github/workflows/cf_basic_signal_windows_publish.yml
  • Package directory: sandcastle/cf_basic_steps/cf_basic_signal
  • PyPI tag: cf-basic-signal-v<version>
  • TestPyPI tag: cf-basic-signal-v<version>-test

Local preflight:

powershell -ExecutionPolicy Bypass -File scripts/mimic_windows_python_publish_workflow.ps1 `
  -WorkflowFile .github/workflows/cf_basic_signal_windows_publish.yml `
  -PackageDir sandcastle/cf_basic_steps/cf_basic_signal `
  -PythonExe py `
  -PythonVersion 3.13

Queue a dry-run dispatch:

powershell -ExecutionPolicy Bypass -File scripts/queue_windows_python_publish_workflow.ps1 `
  -WorkflowFile .github/workflows/cf_basic_signal_windows_publish.yml `
  -PackageDir sandcastle/cf_basic_steps/cf_basic_signal `
  -PublishTarget testpypi `
  -Ref main `
  -RequireLocalPass `
  -DryRun

Watch queued runs:

gh run list --workflow cf_basic_signal_windows_publish.yml --limit 10
gh run watch --exit-status

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

cf_basic_signal-0.3.1.tar.gz (37.6 kB view details)

Uploaded Source

Built Distribution

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

cf_basic_signal-0.3.1-cp313-cp313-win_amd64.whl (23.5 kB view details)

Uploaded CPython 3.13Windows x86-64

File details

Details for the file cf_basic_signal-0.3.1.tar.gz.

File metadata

  • Download URL: cf_basic_signal-0.3.1.tar.gz
  • Upload date:
  • Size: 37.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for cf_basic_signal-0.3.1.tar.gz
Algorithm Hash digest
SHA256 411d35eeca8f728a40626eb03b9b25df292b75b550a72a8c0fce2f0d80f9ad40
MD5 9df5790b90f810e28d8439eaec0c3cd2
BLAKE2b-256 5f5191f6e0d22994af18d63b5374a92d9455ff47daeba370d758a0e040c4a76f

See more details on using hashes here.

File details

Details for the file cf_basic_signal-0.3.1-cp313-cp313-win_amd64.whl.

File metadata

File hashes

Hashes for cf_basic_signal-0.3.1-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 272da76ff5026dd7f6ae17df560f05289898e9e78aefc3d2f955ba8029824e6d
MD5 47a20a6cb69ed7e14b495e30ba226d48
BLAKE2b-256 32df449775d3c168e5329e55b7932dca18c03e8f5c708f6fd9b314d0e93055db

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