sgn 0.0.1__tar.gz

sgn-0.0.1/.gitignore

@@ -0,0 +1 @@
+__pycache__

sgn-0.0.1/LICENSE

@@ -0,0 +1,375 @@
+Copyright (c) 2024 Chad Hanna
+
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

sgn-0.0.1/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.1
+Name: sgn
+Version: 0.0.1
+Summary: Streaming Graph Navigator. A framework to help navigate buffers through a graph. The buffers must flow.
+Home-page: https://git.ligo.org/greg/sgn
+Author: Chad Hanna
+Author-email: Chad Hanna <crh184@psu.edu>
+Project-URL: Homepage, https://git.ligo.org/greg/sgn
+Project-URL: Issues, https://git.ligo.org/greg/sgn/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# sgn
+
+This is an attempt to sketch a streaming framework to replace some good aspects of gstlal.
+
+There are the following concepts defined
+
+- **Buffer**: An object designed to carry data through some execution graph
+- **Source Pad**: An object that is designed to create a buffer when asked
+- **Sink Pad**: An object that will receive a buffer when asked
+- **Source Elements**: These manage the creation of buffers on one or more Pads with the assumption that they will be executed as part of a graph
+- **Sink Elements**: These manage the consumption of buffers on one or more Pads with the assumption that they will be executed as part of a graph
+- **Transform Elements**: These manage the consumption of buffers that immediately result in the production of new buffers.
+- **Pipelines**: These manage the graph execution to pull buffers through the graph and potentially handle other events.
+
+## limitations
+
+At the moment only single src / sink elements are supported for trivial linear graphs.  There is a skeleton to start expanding it and it is written such that hopefully it will be possible.
+
+## Getting started
+
+Clone the repo and run ```./test```
+
+```
+e1-054675:greg-fw channa$ ./test 
+{'cnt': 1, 'name': 'transform'}
+{'cnt': 2, 'name': 'transform'}
+{'cnt': 3, 'name': 'transform'}
+{'cnt': 4, 'name': 'transform'}
+{'cnt': 5, 'name': 'transform'}
+{'cnt': 6, 'name': 'transform'}
+{'cnt': 7, 'name': 'transform'}
+{'cnt': 8, 'name': 'transform'}
+{'cnt': 9, 'name': 'transform'}
+{'cnt': 10, 'name': 'transform'}
+{'cnt': 11, 'name': 'transform'}
+...
+```

sgn-0.0.1/README.md

@@ -0,0 +1,37 @@
+# sgn
+
+This is an attempt to sketch a streaming framework to replace some good aspects of gstlal.
+
+There are the following concepts defined
+
+- **Buffer**: An object designed to carry data through some execution graph
+- **Source Pad**: An object that is designed to create a buffer when asked
+- **Sink Pad**: An object that will receive a buffer when asked
+- **Source Elements**: These manage the creation of buffers on one or more Pads with the assumption that they will be executed as part of a graph
+- **Sink Elements**: These manage the consumption of buffers on one or more Pads with the assumption that they will be executed as part of a graph
+- **Transform Elements**: These manage the consumption of buffers that immediately result in the production of new buffers.
+- **Pipelines**: These manage the graph execution to pull buffers through the graph and potentially handle other events.
+
+## limitations
+
+At the moment only single src / sink elements are supported for trivial linear graphs.  There is a skeleton to start expanding it and it is written such that hopefully it will be possible.
+
+## Getting started
+
+Clone the repo and run ```./test```
+
+```
+e1-054675:greg-fw channa$ ./test 
+{'cnt': 1, 'name': 'transform'}
+{'cnt': 2, 'name': 'transform'}
+{'cnt': 3, 'name': 'transform'}
+{'cnt': 4, 'name': 'transform'}
+{'cnt': 5, 'name': 'transform'}
+{'cnt': 6, 'name': 'transform'}
+{'cnt': 7, 'name': 'transform'}
+{'cnt': 8, 'name': 'transform'}
+{'cnt': 9, 'name': 'transform'}
+{'cnt': 10, 'name': 'transform'}
+{'cnt': 11, 'name': 'transform'}
+...
+```

sgn-0.0.1/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = [
+    "setuptools>=42",
+    "setuptools_scm[toml]>=3.4.3",
+    "wheel",
+]
+build-backend = "setuptools.build_meta"
+
+
+[project]
+name = "sgn"
+version = "0.0.1"
+authors = [
+  { name="Chad Hanna", email="crh184@psu.edu" },
+]
+description = "Streaming Graph Navigator. A framework to help navigate buffers through a graph. The buffers must flow."
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://git.ligo.org/greg/sgn"
+Issues = "https://git.ligo.org/greg/sgn/issues"

sgn-0.0.1/setup.cfg

@@ -0,0 +1,37 @@
+[metadata]
+name = sgn
+author = Chad Hanna
+author_email = crh184@psu.edu
+description = A framework to help navigate buffers through a graph. The buffers must flow.
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://git.ligo.org/greg/sgn
+project_urls = 
+	Bug Tracker = https://git.ligo.org/greg/sgn/-/issues
+classifiers = 
+	Programming Language :: Python :: 3
+	License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
+	Operating System :: OS Independent
+
+[options]
+package_dir = 
+	= src
+packages = find:
+python_requires = >=3.9
+include_package_data = True
+
+[options.packages.find]
+where = src
+
+[flake8]
+exclude = .git,docs,build,dist,test,*__init__.py,*_version.py, versioneer.py
+max-line-length = 1000
+ignore = E129 W504 W503 E203 E266
+
+[tool:pytest]
+addopts = -p no:warnings
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

sgn-0.0.1/setup.py

@@ -0,0 +1,7 @@
+#!/usr/bin/env python
+import setuptools
+
+
+if __name__ == "__main__":
+    setuptools.setup()
+

sgn-0.0.1/src/sgn/apps/__init__.py

@@ -0,0 +1,91 @@
+from .. sources import *
+from .. transforms import *
+from .. sinks import *
+import graphlib
+import asyncio
+import queue
+
+class Pipeline(object):
+
+    src_elements = sources_registry
+    transform_elements = transforms_registry 
+    sink_elements = sinks_registry 
+
+    @initializer
+    def __init__(self, **kwargs):
+        """
+        Class to establish and excecute a graph of elements that will process buffers.
+
+        Registers methods to produce src, transform and sink elements and to assemble those elements
+        in a directed acyclic graph.  Also establishes an event loop.
+        """
+        self.head = None
+        self.graph = {}
+        self.loop = asyncio.get_event_loop()
+        self.sources = {} 
+        self.sinks = {}
+        self.transforms = {}
+        self.src_pads = {}
+        self.sink_pads = {} # FIXME populate this
+
+        for method in self.src_elements:
+            def _f(method = method, **kwargs):
+                self.head = eval("%s(**kwargs)" % method)
+                self.sources[self.head.name] = self.head
+                self.src_pads.update(self.head.src_pad_dict)
+                self.graph.update(self.head.graph)
+                return self
+            setattr(self, method, _f)
+        for method in self.transform_elements:
+            def _f(method = method, **kwargs):
+                t = eval("%s(**kwargs)" % method)
+                h = self.head if "src_pad_name" not in kwargs else self.src_pads[kwargs["src_pad_name"]]
+                t.link(h, **kwargs)
+                self.graph.update(t.graph)
+                self.head = t
+                self.transforms[self.head.name] = self.head
+                self.src_pads.update(self.head.src_pad_dict)
+                self.sink_pads.update(self.head.sink_pad_dict)
+                return self
+            setattr(self, method, _f)
+        for method in self.sink_elements:
+            def _f(method = method, **kwargs):
+                s = eval("%s(**kwargs)" % method)
+                h = self.head if "src_pad_name" not in kwargs else self.src_pads[kwargs["src_pad_name"]]
+                s.link(h, **kwargs)
+                self.sinks[s.name] = s
+                self.sink_pads.update(s.sink_pad_dict)
+                self.head = None
+                self.graph.update(s.graph)
+                return self
+            setattr(self, method, _f)
+
+    def link(self, **kwargs):
+        """
+        link a src pad to a sink pad when both are already added to this pipeline. "src_pad_name" and "sink_pad_name" are required.
+        """
+        assert "src_pad_name" in kwargs and "sink_pad_name" in kwargs
+        self.graph.update(self.sink_pads[kwargs["sink_pad_name"]].link(self.src_pads[kwargs["src_pad_name"]]))
+        return self 
+
+    async def __execute_graphs(self):
+        # FIXME can we remove the outer while true and somehow use asyncio to schedule these in succession?
+        while not all(e.EOS for e in self.sinks.values()):
+            ts = graphlib.TopologicalSorter(self.graph)
+            ts.prepare()
+            done_nodes = queue.Queue() # blocks by default
+            while ts.is_active():
+                for node in ts.get_ready():
+                    task = self.loop.create_task(node())
+                    def callback(task, ts = ts, node = node, done_nodes = done_nodes):
+                        ts.done(node)
+                        done_nodes.put(node)
+                    task.add_done_callback(callback)
+                    await task
+                done_nodes.get() # blocks until at least one thing is done
+
+    def run(self):
+        """
+        Run the pipeline until End Of Stream (EOS)
+        """
+        return self.loop.run_until_complete(self.__execute_graphs())

sgn-0.0.1/src/sgn/base/__init__.py

@@ -0,0 +1,202 @@
+from functools import wraps
+import inspect
+
+# These could be moved out someday to other modules
+
+# From https://stackoverflow.com/questions/1389180/automatically-initialize-instance-variables
+def initializer(func):
+    """
+    Automatically assigns the parameters.
+
+    >>> class process:
+    ...     @initializer
+    ...     def __init__(self, cmd, reachable=False, user='root'):
+    ...         pass
+    >>> p = process('halt', True)
+    >>> p.cmd, p.reachable, p.user
+    ('halt', True, 'root')
+    """
+    names, varargs, keywords, defaults = inspect.getargspec(func)
+
+    @wraps(func)
+    def wrapper(self, *args, **kargs):
+        for name, arg in list(zip(names[1:], args)) + list(kargs.items()):
+            setattr(self, name, arg)
+
+        for name, default in zip(reversed(names), reversed(defaults or [])):
+            if not hasattr(self, name):
+                setattr(self, name, default)
+
+        func(self, *args, **kargs)
+
+    return wrapper
+
+class Buffer(object):
+    """
+    A generic class to hold the basic unit of data that flows through a graph
+    """
+    @initializer
+    def __init__(self, **kwargs):
+        self.kwargs = kwargs
+    def __repr__(self):
+        return str(self.kwargs)
+
+class Base(object):
+    """
+    A generic class from which all classes that participate in an execution
+    graph should be derived.  It enforces a unique name and hashes based on that
+    name. 
+    """
+    registry = set()
+
+    @initializer
+    def __init__(self, **kwargs):
+        """
+        name must be in kwargs and must not have been used by any derived class instance
+        """
+        assert "name" in kwargs
+        assert kwargs["name"] not in Base.registry
+        Base.registry.add(kwargs["name"])
+
+    def __hash__(self):
+        return hash(self.name)
+
+    def __eq__(self, other):
+        return hash(self) == hash(other)
+
+    def __repr__(self):
+        return self.name
+
+class Pad(Base):
+    """
+    Pads are 1:1 with graph nodes but src and sink pads must be grouped into
+    elements in order to exchange data from sink->src.  src->sink exchanges happen
+    between elements.
+    """
+    @initializer
+    def __init__(self, **kwargs):
+        """
+	A pad must belong to an element and that element must be provided as a
+        keyword argument called "element".  The element must also provide a call
+        function that will be executed when the pad is called
+        """
+        assert "element" in kwargs and "call" in kwargs
+        super(Pad, self).__init__(**kwargs)
+
+
+class SrcPad(Pad):
+    """
+    A pad that provides data through a buffer when asked
+    """
+    @initializer
+    def __init__(self, **kwargs):
+        super(SrcPad, self).__init__(**kwargs)
+
+    async def __call__(self):
+        """
+	When called, a source pad receives a buffer from the element that the
+        pad belongs to.
+        """
+        self.outbuf = self.call(pad = self)
+
+
+
+class SinkPad(Pad):
+    """
+    A pad that receives data from a buffer when asked.  When linked, it returns
+    a dictionary suitable for building a graph in graphlib.
+    """
+    @initializer
+    def __init__(self, **kwargs):
+        super(SinkPad, self).__init__(**kwargs)
+    def link(self, other):
+        """
+	Only sink pads can be linked. A sink pad can be linked to only one
+	source pad, but multiple sink pads may link to the same src pad.
+        Returns a dictionary of dependencies suitable for adding to a graphlib graph.
+        """
+        self.other = other
+        return {self: set((other,))}
+    async def __call__(self):
+        """
+	When called, a sink pad gets the buffer from the linked source pad and
+        then calls the element's provided call function.  NOTE: pads must be called in
+        the correct order such that the upstream sources have new information by the
+        time call is invoked.  This should be done within a directed acyclic graph such
+        as those provided by the apps.Pipeline class.
+        """
+        self.inbuf = self.other.outbuf
+        self.call(self, self.inbuf)
+
+class Element(Base):
+    """
+    A basic container to hold src and sink pads. The assmption is that this
+    will be a base class for code that actually does something. It should never be
+    subclassed directly, instead subclass SrcElement, SinkElement or
+    TransformElement
+    """
+
+    @initializer
+    def __init__(self, **kwargs):
+        super(Element, self).__init__(**kwargs)
+        self.graph = {}
+    def link(self, other, **kwargs):
+        """
+        A element links to another element only on its sink pads.  This function offers a few rules:
+
+        1) If "other" is a source pad, it will be used
+        2) otherwise, if "other" is an element it **must** have only one source pad 
+        3) you must specify a sink pad name if this element instance has more than one sink pad.
+
+	it updates the elements internal dictionary which is suitable for being
+        added to a graphlib graph.
+        """
+        sink_pads_by_name = {p.name:p for p in self.sink_pads}
+        if isinstance(other, Pad):
+            src_pad = other
+        else:
+            assert len(other.src_pads) == 1
+            src_pad = other.src_pads[0]
+        if "sink_pad_name" not in kwargs:
+            assert len(self.sink_pads) == 1
+            sink_pad = self.sink_pads[0]
+        else:
+            sink_pad = sink_pads_by_name[kwargs["sink_pad_name"]]
+        self.graph.update(sink_pad.link(src_pad))
+
+class SrcElement(Element):
+    @initializer
+    def __init__(self, **kwargs):
+        """
+        "src_pads" (iterable) must be in kwargs.  Every source pad is added to the graph with no dependencies.
+        """
+        assert "src_pads" in kwargs
+        super(SrcElement, self).__init__(**kwargs)
+        self.graph.update({s: set() for s in self.src_pads})
+        self.src_pad_dict = {p.name:p for p in self.src_pads}
+
+class TransformElement(Element):
+    @initializer
+    def __init__(self, **kwargs):
+        """
+	Both "src_pads" and "sink_pads" must be in kwargs.  All sink pads
+        depend on all source pads in a transform element. If you don't want that to be
+        true, write more than one transform element.
+        """
+        assert "src_pads" in kwargs and "sink_pads" in kwargs
+        super(TransformElement, self).__init__(**kwargs)
+        self.graph.update({s: set(self.sink_pads) for s in self.src_pads})
+        self.src_pad_dict = {p.name:p for p in self.src_pads}
+        self.sink_pad_dict = {p.name:p for p in self.sink_pads}
+        
+
+class SinkElement(Element):
+    @initializer
+    def __init__(self, **kwargs):
+        """
+        "sink_pads" must be in kwargs
+        """
+        assert "sink_pads" in kwargs
+        super(SinkElement, self).__init__(**kwargs)
+        self.graph = {}
+        self.sink_pad_dict = {p.name:p for p in self.sink_pads}

sgn-0.0.1/src/sgn/sinks/__init__.py

@@ -0,0 +1,29 @@
+from ..base import *
+
+
+class FakeSink(SinkElement):
+    @initializer
+    def __init__(self, **kwargs):
+        """
+	A fake sink element that has sink pads given by "channels" named
+        "name:channel:sink". "channels" is a required kwarg
+        """
+        kwargs["sink_pads"] = [SinkPad(name = "%s:%s:sink" % (kwargs["name"], channel), element=self, call = self.get_buffer) for channel in kwargs["channels"]]
+        super(FakeSink, self).__init__(**kwargs)
+        self.at_eos = {p:False for p in kwargs["sink_pads"]}
+    def get_buffer(self, pad, buf):
+        """
+	getting the buffer on the pad just modifies the name to show this final
+        graph point and the prints it to prove it all works.
+        """
+        self.inbuf = buf
+        self.at_eos[pad] = self.inbuf.EOS
+        print ("buffer flow: ", "%s -> '%s'" % (self.inbuf.name, pad.name))
+    @property
+    def EOS(self):
+        """
+        If buffers on any sink pads are End of Stream (EOS), then mark this whole element as EOS
+        """
+        return any(self.at_eos.values())
+
+sinks_registry = ("FakeSink",)

sgn-0.0.1/src/sgn/sources/__init__.py

@@ -0,0 +1,24 @@
+from .. base import *
+
+
+class FakeSrc(SrcElement):
+    @initializer
+    def __init__(self, **kwargs):
+        """
+        A fake source element "channels" are required and will be used to
+        create src pads with the name "name:channel:src". "num_buffers" is required and
+        sets how many buffers will be created before setting "EOS"
+        """
+        kwargs["src_pads"] = [SrcPad(name = "%s:%s:src" % (kwargs["name"], channel), element=self, call = self.new_buffer) for channel in kwargs["channels"]]
+        self.cnt = {p:0 for p in kwargs["src_pads"]}
+        super(FakeSrc, self).__init__(**kwargs)
+    def new_buffer(self, pad):
+        """
+        New buffers are created on "pad" with an instance specific count and a
+        name derived from the pad name. "EOS" is set if we have surpassed the requested
+        number of buffers.
+        """
+        self.cnt[pad] += 1
+        return Buffer(cnt = self.cnt, name = "'%s'" % pad.name, EOS = self.cnt[pad] > self.num_buffers)
+
+sources_registry = ("FakeSrc",)

sgn-0.0.1/src/sgn/transforms/__init__.py

@@ -0,0 +1,27 @@
+from .. base import *
+
+
+class FakeTransform(TransformElement):
+    @initializer
+    def __init__(self, **kwargs):
+        """
+        A fake transform element with sink pads given by "in_channels" and source pads given by "out_channels". Names are "name:inchannel:sink" and "name:outchannel:src".
+        """
+        assert "in_channels" in kwargs and "out_channels" in kwargs
+        kwargs["src_pads"] = [SrcPad(name = "%s:%s:src" % (kwargs["name"], channel), element = self, call = self.transform_buffer) for channel in self.out_channels]
+        kwargs["sink_pads"] = [SinkPad(name = "%s:%s:sink" % (kwargs["name"], channel), element = self, call = self.get_buffer) for channel in self.in_channels]
+        super(FakeTransform, self).__init__(**kwargs)
+        self.inbuf = {}
+
+    def get_buffer(self, pad, buf):
+        self.inbuf[pad] = buf
+
+    def transform_buffer(self, pad):
+        """
+	The transform buffer just update the name to show the graph history.
+        Useful for proving it works.  "EOS" is set if any input buffers are at EOS.
+        """
+        EOS = any(b.EOS for b in self.inbuf.values())
+        return Buffer(**{"cnt:%s" % b.name:b.cnt for b in self.inbuf.values()}, name = "%s -> '%s'" % ("+".join(b.name for b in self.inbuf.values()), pad.name), EOS = EOS)
+
+transforms_registry = ("FakeTransform",)

sgn-0.0.1/src/sgn.egg-info/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.1
+Name: sgn
+Version: 0.0.1
+Summary: Streaming Graph Navigator. A framework to help navigate buffers through a graph. The buffers must flow.
+Home-page: https://git.ligo.org/greg/sgn
+Author: Chad Hanna
+Author-email: Chad Hanna <crh184@psu.edu>
+Project-URL: Homepage, https://git.ligo.org/greg/sgn
+Project-URL: Issues, https://git.ligo.org/greg/sgn/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# sgn
+
+This is an attempt to sketch a streaming framework to replace some good aspects of gstlal.
+
+There are the following concepts defined
+
+- **Buffer**: An object designed to carry data through some execution graph
+- **Source Pad**: An object that is designed to create a buffer when asked
+- **Sink Pad**: An object that will receive a buffer when asked
+- **Source Elements**: These manage the creation of buffers on one or more Pads with the assumption that they will be executed as part of a graph
+- **Sink Elements**: These manage the consumption of buffers on one or more Pads with the assumption that they will be executed as part of a graph
+- **Transform Elements**: These manage the consumption of buffers that immediately result in the production of new buffers.
+- **Pipelines**: These manage the graph execution to pull buffers through the graph and potentially handle other events.
+
+## limitations
+
+At the moment only single src / sink elements are supported for trivial linear graphs.  There is a skeleton to start expanding it and it is written such that hopefully it will be possible.
+
+## Getting started
+
+Clone the repo and run ```./test```
+
+```
+e1-054675:greg-fw channa$ ./test 
+{'cnt': 1, 'name': 'transform'}
+{'cnt': 2, 'name': 'transform'}
+{'cnt': 3, 'name': 'transform'}
+{'cnt': 4, 'name': 'transform'}
+{'cnt': 5, 'name': 'transform'}
+{'cnt': 6, 'name': 'transform'}
+{'cnt': 7, 'name': 'transform'}
+{'cnt': 8, 'name': 'transform'}
+{'cnt': 9, 'name': 'transform'}
+{'cnt': 10, 'name': 'transform'}
+{'cnt': 11, 'name': 'transform'}
+...
+```

sgn-0.0.1/src/sgn.egg-info/SOURCES.txt

@@ -0,0 +1,17 @@
+.gitignore
+LICENSE
+README.md
+pyproject.toml
+setup.cfg
+setup.py
+test
+src/sgn/__init__.py
+src/sgn.egg-info/PKG-INFO
+src/sgn.egg-info/SOURCES.txt
+src/sgn.egg-info/dependency_links.txt
+src/sgn.egg-info/top_level.txt
+src/sgn/apps/__init__.py
+src/sgn/base/__init__.py
+src/sgn/sinks/__init__.py
+src/sgn/sources/__init__.py
+src/sgn/transforms/__init__.py

sgn-0.0.1/src/sgn.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

sgn-0.0.1/src/sgn.egg-info/top_level.txt

@@ -0,0 +1 @@
+sgn

sgn-0.0.1/test

@@ -0,0 +1,71 @@
+#!/usr/bin/env python3
+from sgn.apps import Pipeline
+        
+
+pipeline = Pipeline()
+
+#
+#          ------                                ------
+#         | src1 |                              | src2 |
+#          ------                                ------
+#         /       \---------------            V1 |    | K1
+#     H1 /         \ L1           \ L1           |    |
+#   ----------    -----------    ----------    ------------
+#  | H1trans1 |  | L1trans1  |  | L1trans2 |  | V1K1trans1 |
+#   ----------    -----------    ----------    ------------
+#          \      /                     \     /      /
+#       H1  \    / L1                 L1 \   / V1   / K1
+#           ------                        -----------
+#          | snk1 |                      | snk2      |
+#           ------                        -----------
+#
+
+
+pipeline.FakeSrc(
+           name = "src1",
+           channels = ("H1","L1"),
+           num_buffers = 2
+         ).FakeTransform(
+           name = "H1trans1", src_pad_name = "src1:H1:src", in_channels = ("H1",), out_channels = ("H1",)
+         ).FakeSink(
+           name = "snk1",
+           channels = ("H1","L1"),
+           sink_pad_name = "snk1:H1:sink"
+         )
+
+pipeline.FakeTransform(
+           name = "L1trans1",
+           src_pad_name = "src1:L1:src", in_channels = ("L1",), out_channels = ("L1",)
+         ).link(
+           src_pad_name = "L1trans1:L1:src",
+           sink_pad_name = "snk1:L1:sink"
+         )
+
+pipeline.FakeTransform(
+           name = "L1trans2",
+           src_pad_name = "src1:L1:src",
+           head = "src1", in_channels = ("L1",), out_channels = ("L1",)
+         ).FakeSink(
+           name = "snk2",
+           channels = ("L1","V1","K1"),
+           sink_pad_name = "snk2:L1:sink"
+         )
+
+pipeline.FakeSrc(
+           name = "src2",
+           channels = ("V1","K1"),
+           num_buffers = 2
+         ).FakeTransform(
+           name = "V1K1trans1", src_pad_name = "src2:V1:src", in_channels = ("V1","K1"), out_channels = ("V1","K1"), sink_pad_name = "V1K1trans1:V1:sink"
+         ).link(
+           src_pad_name = "src2:K1:src",
+           sink_pad_name = "V1K1trans1:K1:sink"
+         ).link(
+           src_pad_name = "V1K1trans1:K1:src",
+           sink_pad_name = "snk2:K1:sink"
+         ).link(
+           src_pad_name = "V1K1trans1:V1:src",
+           sink_pad_name = "snk2:V1:sink"
+         )
+
+pipeline.run()