openspacehdl 0.0.1__py3-none-any.whl

openspacehdl/__init__.py

@@ -0,0 +1,3 @@
+"""Open Space HDL: open-source VHDL IP cores for spacecraft on-board data handling."""
+
+__version__ = "0.0.1"

openspacehdl/__main__.py

@@ -0,0 +1,7 @@
+"""Entry point of python -m openspacehdl."""
+
+import sys
+
+from openspacehdl.cli import main
+
+sys.exit(main())

openspacehdl/cli.py

@@ -0,0 +1,75 @@
+"""Command line of openspacehdl."""
+
+from __future__ import annotations
+
+import argparse
+import sys
+import textwrap
+
+from openspacehdl import __version__
+from openspacehdl.family import Family, Project, load
+
+WIDTH = 100
+INDENT = "    "
+
+
+def _wrap(text: str, indent: str) -> list[str]:
+    return textwrap.wrap(text, WIDTH, initial_indent=indent, subsequent_indent=indent)
+
+
+def _project_lines(family: Family, p: Project) -> list[str]:
+    state = "Coming soon" if not p.public else (f"TRL {p.trl}" if p.trl else "")
+    head = "  ".join(x for x in (p.name, state) if x)
+    lines = [f"  {head}"]
+    if p.tagline:
+        lines.append(f"{INDENT}{', '.join(p.tagline)}")
+    lines += _wrap(p.summary, INDENT)
+    if p.public:
+        if p.trl and p.trl_status:
+            lines += _wrap(f"Status: {p.trl_status}", INDENT)
+        docs = family.docs_url(p)
+        if docs:
+            lines.append(f"{INDENT}Documentation: {docs}")
+        lines.append(f"{INDENT}Source: {family.source_url(p)}")
+    return lines
+
+
+def info(family: Family, name: str | None) -> int:
+    if name is not None:
+        p = family.find(name)
+        if p is None:
+            names = ", ".join(x.name for x in family.projects)
+            print(f"openspacehdl: no project named {name!r}; the family has {names}", file=sys.stderr)
+            return 2
+        print("\n".join(_project_lines(family, p)))
+        return 0
+
+    out = ["Open Space HDL: open-source VHDL IP cores for spacecraft on-board data handling", family.site]
+    for g in family.groups:
+        members = family.members(g)
+        if not members:
+            continue
+        out += ["", g.title, *_wrap(g.summary, "  ")]
+        for p in members:
+            out += ["", *_project_lines(family, p)]
+    print("\n".join(out))
+    return 0
+
+
+def main(argv: list[str] | None = None) -> int:
+    if hasattr(sys.stdout, "reconfigure"):
+        sys.stdout.reconfigure(errors="replace")
+    parser = argparse.ArgumentParser(
+        prog="openspacehdl",
+        description="Open Space HDL: open-source VHDL IP cores for spacecraft on-board data handling.",
+    )
+    parser.add_argument("--version", action="version", version=f"openspacehdl {__version__}")
+    sub = parser.add_subparsers(dest="command", metavar="<command>")
+    p_info = sub.add_parser("info", help="list the projects of the family, as the website shows them")
+    p_info.add_argument("project", nargs="?", help="show only this project (name or repository)")
+    args = parser.parse_args(argv)
+
+    if args.command == "info":
+        return info(load(), args.project)
+    parser.print_help()
+    return 0

openspacehdl/data/family.json

@@ -0,0 +1,158 @@
+{
+  "source": {
+    "repository": "open-space-hdl/open-space-hdl.github.io",
+    "commit": "1b3d619cb4b4cef3fe7a3893a0d0040c1d4049bb"
+  },
+  "site": "https://openspacehdl.org",
+  "github": "https://github.com/open-space-hdl",
+  "groups": [
+    {
+      "id": "interfaces-protocols",
+      "title": "Interfaces & Protocols",
+      "summary": "SpaceWire and SpaceFibre links, CAN and 1553 buses, and the protocols that run over them."
+    },
+    {
+      "id": "processing-modules",
+      "title": "Processing Modules",
+      "summary": "Cores that process payload data on board, such as image compression and encryption."
+    },
+    {
+      "id": "system-infrastructure",
+      "title": "System Infrastructure",
+      "summary": "Cores that move data between the memories and the peripherals of an on-board system."
+    },
+    {
+      "id": "building-blocks",
+      "title": "Building Blocks",
+      "summary": "The fault-tolerant Open Logic entities that every core is built on."
+    }
+  ],
+  "projects": [
+    {
+      "name": "OpenWire",
+      "group": "interfaces-protocols",
+      "tagline": [
+        "ECSS-E-ST-50-12C Rev.1"
+      ],
+      "summary": "SpaceWire port with node interface: Data-Strobe encoding, link control, packets, time-codes and distributed interrupts.",
+      "public": true,
+      "repo": "openwire",
+      "docs": true,
+      "trl": 3,
+      "trl_status": "Fully verified by simulation. Not yet tested on hardware, no flight heritage."
+    },
+    {
+      "name": "OpenFibre",
+      "group": "interfaces-protocols",
+      "tagline": [
+        "ECSS-E-ST-50-11C"
+      ],
+      "summary": "SpaceFibre port with 1 to 4 lanes, up to 32 virtual channels, quality of service, broadcast and error recovery.",
+      "public": true,
+      "repo": "openfibre",
+      "docs": true,
+      "trl": 3,
+      "trl_status": "Fully verified by simulation. Not yet tested on hardware, no flight heritage."
+    },
+    {
+      "name": "OpenRMAP",
+      "group": "interfaces-protocols",
+      "tagline": [
+        "ECSS-E-ST-50-52C"
+      ],
+      "summary": "RMAP target and initiator for reading and writing remote memory over SpaceWire and SpaceFibre networks.",
+      "public": true,
+      "repo": "openrmap",
+      "docs": true,
+      "trl": 3,
+      "trl_status": "Fully verified by simulation. Not yet tested on hardware, no flight heritage."
+    },
+    {
+      "name": "OpenSPP",
+      "group": "interfaces-protocols",
+      "tagline": [
+        "CCSDS 133.0-B-2"
+      ],
+      "summary": "Space Packet service with APID routing and loss detection for up to 16 send and 16 receive ports, over SpaceWire, SpaceFibre or other links.",
+      "public": true,
+      "repo": "openspp",
+      "docs": true,
+      "trl": 3,
+      "trl_status": "Fully verified by simulation. Not yet tested on hardware, no flight heritage."
+    },
+    {
+      "name": "OpenCAN",
+      "group": "interfaces-protocols",
+      "tagline": [
+        "ECSS-E-ST-50-15C"
+      ],
+      "summary": "CAN network core with nominal and redundant bus, bus redundancy management, CANopen services and time distribution.",
+      "public": false
+    },
+    {
+      "name": "Open1553",
+      "group": "interfaces-protocols",
+      "tagline": [
+        "ECSS-E-ST-50-13C"
+      ],
+      "summary": "Bus controller, remote terminal and bus monitor for the dual-redundant 1553 data bus, with the Manchester II codec in the core.",
+      "public": false
+    },
+    {
+      "name": "OpenCompact",
+      "group": "processing-modules",
+      "tagline": [
+        "CCSDS 123.0-B-2"
+      ],
+      "summary": "Lossless and near-lossless compressor for multispectral and hyperspectral images, with all predictors and entropy coders of the standard.",
+      "public": true,
+      "repo": "opencompact",
+      "docs": true,
+      "trl": 3,
+      "trl_status": "Fully verified by simulation. Not yet tested on hardware, no flight heritage."
+    },
+    {
+      "name": "OpenCrypto",
+      "group": "processing-modules",
+      "tagline": [
+        "CCSDS 352.0-B-2"
+      ],
+      "summary": "Authenticated encryption and decryption of real-time data streams with AES-GCM, key table and IV generation.",
+      "public": true,
+      "repo": "opencrypto",
+      "docs": true,
+      "trl": 3,
+      "trl_status": "Fully verified by simulation. Not yet tested on hardware, no flight heritage."
+    },
+    {
+      "name": "OpenDMA",
+      "group": "system-infrastructure",
+      "tagline": [
+        "AXI4",
+        "AXI4-Stream",
+        "Scatter/Gather"
+      ],
+      "summary": "DMA core between AXI4 memory and AXI4-Stream peripherals, register-compatible with the AMD AXI DMA so that its drivers run unchanged.",
+      "public": true,
+      "repo": "opendma",
+      "docs": true,
+      "trl": 3,
+      "trl_status": "Fully verified by simulation. Not yet tested on hardware, no flight heritage."
+    },
+    {
+      "name": "Open Logic FT",
+      "group": "building-blocks",
+      "tagline": [
+        "ECC",
+        "TMR",
+        "Safe FSMs"
+      ],
+      "summary": "Fault-tolerant fork of Open Logic: RAMs and FIFOs with SECDED ECC, clock crossings with triplicated synchronisers.",
+      "public": true,
+      "repo": "open-logic-ft",
+      "docs": true,
+      "trl": 3,
+      "trl_status": "Fully verified by simulation. Not yet tested on hardware, no flight heritage."
+    }
+  ]
+}

openspacehdl/family.py

@@ -0,0 +1,71 @@
+"""The projects of the family, as the website shows them (data/family.json, written by tools/family_data.py)."""
+
+from __future__ import annotations
+
+import json
+import re
+from dataclasses import dataclass
+from importlib import resources
+
+
+@dataclass(frozen=True)
+class Group:
+    id: str
+    title: str
+    summary: str
+
+
+@dataclass(frozen=True)
+class Project:
+    name: str
+    group: str
+    tagline: tuple[str, ...]
+    summary: str
+    public: bool
+    repo: str | None = None
+    docs: bool = False
+    trl: int | None = None
+    trl_status: str | None = None
+
+
+@dataclass(frozen=True)
+class Family:
+    site: str
+    github: str
+    source_commit: str
+    groups: tuple[Group, ...]
+    projects: tuple[Project, ...]
+
+    def docs_url(self, project: Project) -> str | None:
+        """Documentation site of a public project, or None."""
+        return f"{self.site}/{project.repo}/" if project.public and project.docs else None
+
+    def source_url(self, project: Project) -> str | None:
+        """Repository of a public project, or None."""
+        return f"{self.github}/{project.repo}" if project.public else None
+
+    def members(self, group: Group) -> list[Project]:
+        return [p for p in self.projects if p.group == group.id]
+
+    def find(self, name: str) -> Project | None:
+        """The project with this name or repository name, ignoring case, spaces and hyphens."""
+        key = _key(name)
+        for p in self.projects:
+            if key in (_key(p.name), _key(p.repo or "")):
+                return p
+        return None
+
+
+def _key(text: str) -> str:
+    return re.sub(r"[^a-z0-9]", "", text.lower())
+
+
+def load() -> Family:
+    data = json.loads(resources.files("openspacehdl").joinpath("data/family.json").read_text(encoding="utf-8"))
+    return Family(
+        site=data["site"],
+        github=data["github"],
+        source_commit=data["source"]["commit"],
+        groups=tuple(Group(**g) for g in data["groups"]),
+        projects=tuple(Project(**{**p, "tagline": tuple(p["tagline"])}) for p in data["projects"]),
+    )

openspacehdl-0.0.1.dist-info/METADATA

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: openspacehdl
+Version: 0.0.1
+Summary: Open Space HDL, open-source VHDL IP cores for spacecraft on-board data handling: early release that lists the family
+Author-email: Julian Schneider <julian.schneider@openspacehdl.org>
+License-Expression: MIT
+Project-URL: Homepage, https://openspacehdl.org
+Keywords: vhdl,fpga,ip-core,space,spacewire,spacefibre,ccsds,ecss
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# openspacehdl
+
+Python package of [Open Space HDL](https://openspacehdl.org), a family of open-source VHDL IP cores for spacecraft
+on-board data handling.
+
+This is an early release. It lists the projects of the family as the website shows them; it does not contain the
+cores or any tools yet.
+
+## Install
+
+```shell
+pip install openspacehdl
+```
+
+The package needs Python 3.10 or later and has no dependencies. On a machine without network access, copy the wheel
+and install it from the file:
+
+```shell
+pip install openspacehdl-<version>-py3-none-any.whl
+```
+
+## Use
+
+```shell
+openspacehdl --version          # version of the package
+openspacehdl info               # every project of the family: standard, summary, TRL, documentation and source
+openspacehdl info OpenFibre     # one project, by name or repository name
+```
+
+`python -m openspacehdl` works the same way.
+
+The list comes from the project cards of [openspacehdl.org](https://openspacehdl.org) at the time of the release.
+A project that is not yet public is listed as "Coming soon", without links.
+
+## Development
+
+```shell
+pip install -r requirements-dev.txt
+pip install -e .
+pytest
+python tools/family_data.py --site <clone of open-space-hdl.github.io> --check
+python -m build
+```
+
+`tools/family_data.py` writes `src/openspacehdl/data/family.json` from `_data/projects.yml` and
+`_data/project_groups.yml` of the website repository; `--check` only compares.
+
+## Licence
+
+The package is released under the [MIT License](LICENSE). The IP cores of the family have their own licence (PSI HDL
+Library License), stated in each repository.

openspacehdl-0.0.1.dist-info/RECORD

@@ -0,0 +1,11 @@
+openspacehdl/__init__.py,sha256=Tsyl-ggC0qKMvJfncedPGB8FeljpvL1HMsYAIF70JMI,110
+openspacehdl/__main__.py,sha256=CXIDS0eQTuE7K0znw8awHDgVFR7OTE-dxw0brVCacqs,110
+openspacehdl/cli.py,sha256=YBig2dywwbGCBkdbxow9r1rdgIcGD_Li0_leZBwuubQ,2618
+openspacehdl/family.py,sha256=0UfEd4Ra0-_M20fOqUCX8AKb_ZvR1wT0BeMZGgvnsPo,2054
+openspacehdl/data/family.json,sha256=FMGTdknJ_wLTmy9AsdCkNIVgH0Wgk1zp0r0hc9cg_3M,5345
+openspacehdl-0.0.1.dist-info/licenses/LICENSE,sha256=Omis6exD_B3M_XQlWdtMC1fJ63si-aELmwojPxI9Uh0,1073
+openspacehdl-0.0.1.dist-info/METADATA,sha256=wDSsBQgv-GnLNsG-6nhaiPwX4-SYwROo1r4MZ5frhEA,2833
+openspacehdl-0.0.1.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+openspacehdl-0.0.1.dist-info/entry_points.txt,sha256=weweKiUryfr4MkHrERM_IxoiTz4dUzx7xqxv4P7eOGc,55
+openspacehdl-0.0.1.dist-info/top_level.txt,sha256=N0ujaubIerqVdOeBSQOfs8ileSukmfYI_IBk-kiGgRI,13
+openspacehdl-0.0.1.dist-info/RECORD,,

openspacehdl-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

openspacehdl-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+openspacehdl = openspacehdl.cli:main

openspacehdl-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Julian Schneider
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

openspacehdl-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+openspacehdl