cq-acis 0.1.0__tar.gz

cq_acis-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 cq-acis contributors
+
+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.

cq_acis-0.1.0/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.4
+Name: cq-acis
+Version: 0.1.0
+Summary: ACIS SAT/SAB parsing experiments for CadQuery
+License: MIT License
+        
+        Copyright (c) 2026 cq-acis contributors
+        
+        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.
+        
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cadquery>=2.4
+Dynamic: license-file
+
+# cq-acis
+
+Parse ACIS SAT/SAB data and convert the supported analytic B-rep subset to
+CadQuery/OpenCascade shapes.
+
+日本語版: [README.ja.md](README.ja.md)
+
+> This project is experimental. ACIS SAT versions and producer-specific
+> records vary, so unsupported entities are preserved as raw records and
+> conversion fails explicitly when an exact shape cannot be built.
+
+## Features
+
+- SAT container detection and ASCII record framing
+- Legacy one-line and modern three-line SAT headers
+- Counted `@<length>` strings used by SAT 7 and later
+- SAB and Autodesk ShapeManager SAB preamble detection
+- Entity-reference graph validation for `$n` pointers
+- Typed decoding for SAT save versions 105, 400, 600, and 700
+- Typed topology and analytic geometry entities:
+  `body`, `lump`, `shell`, `face`, `loop`, `coedge`, `edge`, `vertex`,
+  `point`, `straight-curve`, `ellipse-curve`, `plane-surface`,
+  `cone-surface`, and `transform`
+- Exact CadQuery conversion for line, circular/elliptical edge, plane,
+  cylindrical, and circular-conical geometry
+- Splitting of non-manifold ACIS shells into valid CadQuery solids and
+  compounds
+- Preservation of unsupported records as `RawEntity`
+
+Elliptical cones, elliptical cylinders, sheared placements, and unsupported
+surface/curve types are rejected rather than approximated.
+
+## Installation
+
+The CadQuery converter is installed with the default dependencies:
+
+```bash
+python -m pip install cq-acis
+```
+
+For a source checkout:
+
+```bash
+python -m pip install -e .
+```
+
+## Quick start
+
+Parse SAT records and resolve topology references:
+
+```python
+from cq_acis import BodyEntity, parse_sat_model
+
+with open("model.sat", "rb") as source:
+    model = parse_sat_model(source.read())
+
+for body in model.bodies():
+    assert isinstance(body, BodyEntity)
+    lump = model.resolve(body.lump)
+    print(body.index, lump.index if lump else None)
+```
+
+Convert the bodies to a CadQuery `Workplane`:
+
+```python
+from cq_acis import import_sat_file
+
+result = import_sat_file("model.sat")
+shape = result.val()
+assert shape.isValid()
+print(shape.Volume())
+```
+
+## Example and visual inspection
+
+[`examples/parse_sat.py`](examples/parse_sat.py) parses a SAT file, prints body
+statistics, and exports STEP, STL, and SVG files.
+
+```bash
+PYTHONPATH=src python examples/parse_sat.py
+PYTHONPATH=src python examples/parse_sat.py path/to/model.sat \
+  --output-dir /tmp/cq-acis-output
+```
+
+Open the generated STL or STEP in any 3D CAD viewer. With the optional
+`ocp_vscode` viewer installed, try:
+
+```bash
+PYTHONPATH=src python examples/parse_sat.py --show
+```
+
+## Supported entities and conversion scope
+
+The parser currently has typed support for:
+
+```text
+body, lump, shell, face, loop, coedge, edge, vertex,
+point, straight-curve, ellipse-curve,
+plane-surface, cone-surface, transform
+```
+
+Typed support does not imply that every entity can already be converted to a
+CadQuery shape. Conversion is exact-only and raises `CadQueryConversionError`
+for unsupported geometry.
+
+## Development corpus
+
+The pinned development corpus is not included in the Python wheel. It is kept
+in this repository for parser and conversion regression tests. Sources,
+upstream commits, and SHA-1 values are recorded in
+[`corpus/sources.lock.json`](corpus/sources.lock.json); downloaded file hashes
+and SAT metadata are recorded in
+[`corpus/manifest.jsonl`](corpus/manifest.jsonl).
+
+```bash
+python scripts/fetch_corpus.py
+python scripts/fetch_corpus.py --check
+```
+
+Review [`corpus/README.md`](corpus/README.md) and `corpus/licenses/` before
+redistributing third-party files.
+
+## Testing
+
+Run the full test suite from a source checkout:
+
+```bash
+PYTHONPATH=src python -m unittest discover -s tests -v
+```
+
+The pinned corpus currently covers 25 artifacts, including 23 SAT files and 2
+SAB files. CadQuery regression tests convert 23 SAT artifacts and 147 bodies.
+
+## Project status
+
+The package is under active development. The public API and supported SAT
+subset may change while broader producer/version coverage is added.
+
+## License
+
+The project code is licensed under the [MIT License](LICENSE). Third-party
+corpus files have separate notices under [`corpus/licenses/`](corpus/licenses/);
+consult those notices before redistribution.

cq_acis-0.1.0/README.md

@@ -0,0 +1,143 @@
+# cq-acis
+
+Parse ACIS SAT/SAB data and convert the supported analytic B-rep subset to
+CadQuery/OpenCascade shapes.
+
+日本語版: [README.ja.md](README.ja.md)
+
+> This project is experimental. ACIS SAT versions and producer-specific
+> records vary, so unsupported entities are preserved as raw records and
+> conversion fails explicitly when an exact shape cannot be built.
+
+## Features
+
+- SAT container detection and ASCII record framing
+- Legacy one-line and modern three-line SAT headers
+- Counted `@<length>` strings used by SAT 7 and later
+- SAB and Autodesk ShapeManager SAB preamble detection
+- Entity-reference graph validation for `$n` pointers
+- Typed decoding for SAT save versions 105, 400, 600, and 700
+- Typed topology and analytic geometry entities:
+  `body`, `lump`, `shell`, `face`, `loop`, `coedge`, `edge`, `vertex`,
+  `point`, `straight-curve`, `ellipse-curve`, `plane-surface`,
+  `cone-surface`, and `transform`
+- Exact CadQuery conversion for line, circular/elliptical edge, plane,
+  cylindrical, and circular-conical geometry
+- Splitting of non-manifold ACIS shells into valid CadQuery solids and
+  compounds
+- Preservation of unsupported records as `RawEntity`
+
+Elliptical cones, elliptical cylinders, sheared placements, and unsupported
+surface/curve types are rejected rather than approximated.
+
+## Installation
+
+The CadQuery converter is installed with the default dependencies:
+
+```bash
+python -m pip install cq-acis
+```
+
+For a source checkout:
+
+```bash
+python -m pip install -e .
+```
+
+## Quick start
+
+Parse SAT records and resolve topology references:
+
+```python
+from cq_acis import BodyEntity, parse_sat_model
+
+with open("model.sat", "rb") as source:
+    model = parse_sat_model(source.read())
+
+for body in model.bodies():
+    assert isinstance(body, BodyEntity)
+    lump = model.resolve(body.lump)
+    print(body.index, lump.index if lump else None)
+```
+
+Convert the bodies to a CadQuery `Workplane`:
+
+```python
+from cq_acis import import_sat_file
+
+result = import_sat_file("model.sat")
+shape = result.val()
+assert shape.isValid()
+print(shape.Volume())
+```
+
+## Example and visual inspection
+
+[`examples/parse_sat.py`](examples/parse_sat.py) parses a SAT file, prints body
+statistics, and exports STEP, STL, and SVG files.
+
+```bash
+PYTHONPATH=src python examples/parse_sat.py
+PYTHONPATH=src python examples/parse_sat.py path/to/model.sat \
+  --output-dir /tmp/cq-acis-output
+```
+
+Open the generated STL or STEP in any 3D CAD viewer. With the optional
+`ocp_vscode` viewer installed, try:
+
+```bash
+PYTHONPATH=src python examples/parse_sat.py --show
+```
+
+## Supported entities and conversion scope
+
+The parser currently has typed support for:
+
+```text
+body, lump, shell, face, loop, coedge, edge, vertex,
+point, straight-curve, ellipse-curve,
+plane-surface, cone-surface, transform
+```
+
+Typed support does not imply that every entity can already be converted to a
+CadQuery shape. Conversion is exact-only and raises `CadQueryConversionError`
+for unsupported geometry.
+
+## Development corpus
+
+The pinned development corpus is not included in the Python wheel. It is kept
+in this repository for parser and conversion regression tests. Sources,
+upstream commits, and SHA-1 values are recorded in
+[`corpus/sources.lock.json`](corpus/sources.lock.json); downloaded file hashes
+and SAT metadata are recorded in
+[`corpus/manifest.jsonl`](corpus/manifest.jsonl).
+
+```bash
+python scripts/fetch_corpus.py
+python scripts/fetch_corpus.py --check
+```
+
+Review [`corpus/README.md`](corpus/README.md) and `corpus/licenses/` before
+redistributing third-party files.
+
+## Testing
+
+Run the full test suite from a source checkout:
+
+```bash
+PYTHONPATH=src python -m unittest discover -s tests -v
+```
+
+The pinned corpus currently covers 25 artifacts, including 23 SAT files and 2
+SAB files. CadQuery regression tests convert 23 SAT artifacts and 147 bodies.
+
+## Project status
+
+The package is under active development. The public API and supported SAT
+subset may change while broader producer/version coverage is added.
+
+## License
+
+The project code is licensed under the [MIT License](LICENSE). Third-party
+corpus files have separate notices under [`corpus/licenses/`](corpus/licenses/);
+consult those notices before redistribution.

cq_acis-0.1.0/pyproject.toml

@@ -0,0 +1,19 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cq-acis"
+version = "0.1.0"
+description = "ACIS SAT/SAB parsing experiments for CadQuery"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = ["cadquery>=2.4"]
+license = {file = "LICENSE"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["tests"]

cq_acis-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

cq_acis-0.1.0/src/cq_acis/__init__.py

@@ -0,0 +1,107 @@
+"""Low-level ACIS container and SAT parsing helpers."""
+
+from .sat import (
+    AcisContainer,
+    SatDocument,
+    SatHeader,
+    SatParseError,
+    SatRecord,
+    detect_container,
+    iter_sat_records,
+    parse_sat,
+    parse_sat_header,
+)
+from .tokens import CountedString, EntityRef, NULL_REF, SatToken, tokenize_record
+from .graph import (
+    RawEntity,
+    SatEntityGraph,
+    SatGraphError,
+    build_entity_graph,
+    parse_sat_graph,
+)
+from .entities import (
+    SUPPORTED_ENTITY_TYPES,
+    BodyEntity,
+    ConeSurfaceEntity,
+    CoedgeEntity,
+    DecodedEntity,
+    EdgeEntity,
+    EllipseCurveEntity,
+    EntityDecodeError,
+    FaceEntity,
+    LoopEntity,
+    LumpEntity,
+    ParameterRange,
+    PlaneSurfaceEntity,
+    PointEntity,
+    SatModel,
+    ShellEntity,
+    StraightCurveEntity,
+    TransformEntity,
+    Vec3,
+    VertexEntity,
+    decode_entity,
+    decode_sat_model,
+    parse_sat_model,
+)
+from .cadquery import (
+    CadQueryConversionError,
+    CadQueryConverter,
+    CadQueryDependencyError,
+    convert_sat_model,
+    import_sat_data,
+    import_sat_file,
+    to_cadquery,
+)
+
+__all__ = [
+    "AcisContainer",
+    "BodyEntity",
+    "CadQueryConversionError",
+    "CadQueryConverter",
+    "CadQueryDependencyError",
+    "ConeSurfaceEntity",
+    "CoedgeEntity",
+    "CountedString",
+    "DecodedEntity",
+    "EdgeEntity",
+    "EllipseCurveEntity",
+    "EntityDecodeError",
+    "EntityRef",
+    "FaceEntity",
+    "LoopEntity",
+    "LumpEntity",
+    "NULL_REF",
+    "ParameterRange",
+    "PlaneSurfaceEntity",
+    "PointEntity",
+    "RawEntity",
+    "SUPPORTED_ENTITY_TYPES",
+    "SatDocument",
+    "SatEntityGraph",
+    "SatGraphError",
+    "SatHeader",
+    "SatModel",
+    "SatParseError",
+    "SatRecord",
+    "SatToken",
+    "ShellEntity",
+    "StraightCurveEntity",
+    "TransformEntity",
+    "Vec3",
+    "VertexEntity",
+    "build_entity_graph",
+    "convert_sat_model",
+    "decode_entity",
+    "decode_sat_model",
+    "detect_container",
+    "iter_sat_records",
+    "import_sat_data",
+    "import_sat_file",
+    "parse_sat",
+    "parse_sat_graph",
+    "parse_sat_header",
+    "parse_sat_model",
+    "tokenize_record",
+    "to_cadquery",
+]