gemmology-plugin 1.0.0__tar.gz

gemmology_plugin-1.0.0/LICENSE

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

gemmology_plugin-1.0.0/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: gemmology-plugin
+Version: 1.0.0
+Summary: Claude Code plugin for coloured gemstone expertise and crystal visualization
+Author-email: Fabian Schuh <fabian@gemmology.dev>
+License: MIT
+Project-URL: Homepage, https://gemmology.dev
+Project-URL: Documentation, https://gemmology.dev/docs
+Project-URL: Repository, https://github.com/gemmology-dev/gemmology-plugin
+Project-URL: Issues, https://github.com/gemmology-dev/gemmology-plugin/issues
+Keywords: gemmology,crystallography,gemstones,visualization,claude-code,plugin
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: gemmology-cdl-parser>=1.0.0
+Requires-Dist: gemmology-mineral-database>=1.0.0
+Requires-Dist: gemmology-crystal-geometry>=1.0.0
+Requires-Dist: gemmology-crystal-renderer>=1.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Provides-Extra: lsp
+Requires-Dist: gemmology-cdl-lsp>=1.0.0; extra == "lsp"
+Provides-Extra: all
+Requires-Dist: gemmology-cdl-lsp>=1.0.0; extra == "all"
+Dynamic: license-file
+
+# Gemmology Plugin
+
+A Claude Code plugin for coloured gemstone expertise and crystal visualization.
+
+Part of the [Gemmology Project](https://gemmology.dev).
+
+## Features
+
+- **Crystal Visualization**: Generate SVG, STL, and glTF visualizations of crystal structures
+- **Mineral Database**: Access FGA-curriculum aligned gemstone data for 50+ minerals
+- **CDL Parser**: Parse and validate Crystal Description Language notation
+- **Gem Identification**: Interactive workflow for systematic gemstone identification
+
+## Installation
+
+```bash
+pip install gemmology-plugin
+```
+
+This installs the core plugin along with all component packages:
+- `cdl-parser` - Crystal Description Language parser
+- `mineral-database` - Gemstone property database
+- `crystal-geometry` - 3D crystal geometry engine
+- `crystal-renderer` - SVG/STL/glTF visualization
+
+### Optional: Language Server
+
+For editor integration with CDL syntax highlighting and completion:
+
+```bash
+pip install gemmology-plugin[lsp]
+```
+
+## Quick Start
+
+### Command Line
+
+```bash
+# Generate crystal visualization
+gemmology crystal-svg --preset diamond -o diamond.svg
+
+# List available presets
+gemmology list-presets
+
+# Get mineral information
+gemmology info ruby
+```
+
+### Python API
+
+```python
+from gemmology_plugin import generate_crystal_svg, get_preset
+
+# Generate from CDL notation
+svg = generate_crystal_svg("cubic[m3m]:{111}@1.0 + {100}@1.3")
+
+# Generate from preset
+ruby = get_preset("ruby")
+svg = generate_crystal_svg(ruby['cdl'], info_properties={'name': ruby['name']})
+```
+
+## Claude Code Plugin
+
+When used as a Claude Code plugin, this package provides:
+
+### Commands
+
+- `/crystal-svg` - Generate crystal structure visualizations
+- `/identify-gem` - Interactive gemstone identification workflow
+
+### Agents
+
+Expert agents for domain-specific tasks:
+- `crystallography-expert` - Crystal systems, symmetry, Miller indices
+- `gemmology-expert` - Gemstone properties, FGA data
+- `cdl-expert` - CDL syntax and parsing
+
+### Skills
+
+Reference skills covering FGA curriculum topics:
+- Physical properties (hardness, SG, cleavage)
+- Optical properties (RI, birefringence, dispersion)
+- Inclusions and fingerprints
+- Treatments and enhancements
+- Synthetics and simulants
+- Origin determination
+
+## CDL Syntax Overview
+
+Crystal Description Language (CDL) provides precise control over crystal morphology:
+
+```
+system[point_group]:{form}@distance + {form}@distance
+```
+
+Examples:
+```
+cubic[m3m]:{111}                    # Octahedron
+cubic[m3m]:{111}@1.0 + {100}@1.3    # Truncated octahedron
+trigonal[-3m]:{10-10}@1.0 + {0001}@0.5  # Quartz prism
+```
+
+## Component Packages
+
+This plugin integrates:
+
+| Package | Description |
+|---------|-------------|
+| [cdl-parser](https://github.com/gemmology-dev/cdl-parser) | CDL parsing and validation |
+| [mineral-database](https://github.com/gemmology-dev/mineral-database) | Gemstone property database |
+| [crystal-geometry](https://github.com/gemmology-dev/crystal-geometry) | 3D geometry generation |
+| [crystal-renderer](https://github.com/gemmology-dev/crystal-renderer) | Visualization and export |
+| [cdl-lsp](https://github.com/gemmology-dev/cdl-lsp) | Language server (optional) |
+
+## Development
+
+```bash
+git clone https://github.com/gemmology-dev/gemmology-plugin
+cd gemmology-plugin
+pip install -e ".[dev]"
+pytest tests/ -v
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## Links
+
+- [Documentation](https://gemmology.dev/docs)
+- [CDL Specification](https://gemmology.dev/cdl)
+- [GitHub Repository](https://github.com/gemmology-dev/gemmology-plugin)

gemmology_plugin-1.0.0/README.md

@@ -0,0 +1,132 @@
+# Gemmology Plugin
+
+A Claude Code plugin for coloured gemstone expertise and crystal visualization.
+
+Part of the [Gemmology Project](https://gemmology.dev).
+
+## Features
+
+- **Crystal Visualization**: Generate SVG, STL, and glTF visualizations of crystal structures
+- **Mineral Database**: Access FGA-curriculum aligned gemstone data for 50+ minerals
+- **CDL Parser**: Parse and validate Crystal Description Language notation
+- **Gem Identification**: Interactive workflow for systematic gemstone identification
+
+## Installation
+
+```bash
+pip install gemmology-plugin
+```
+
+This installs the core plugin along with all component packages:
+- `cdl-parser` - Crystal Description Language parser
+- `mineral-database` - Gemstone property database
+- `crystal-geometry` - 3D crystal geometry engine
+- `crystal-renderer` - SVG/STL/glTF visualization
+
+### Optional: Language Server
+
+For editor integration with CDL syntax highlighting and completion:
+
+```bash
+pip install gemmology-plugin[lsp]
+```
+
+## Quick Start
+
+### Command Line
+
+```bash
+# Generate crystal visualization
+gemmology crystal-svg --preset diamond -o diamond.svg
+
+# List available presets
+gemmology list-presets
+
+# Get mineral information
+gemmology info ruby
+```
+
+### Python API
+
+```python
+from gemmology_plugin import generate_crystal_svg, get_preset
+
+# Generate from CDL notation
+svg = generate_crystal_svg("cubic[m3m]:{111}@1.0 + {100}@1.3")
+
+# Generate from preset
+ruby = get_preset("ruby")
+svg = generate_crystal_svg(ruby['cdl'], info_properties={'name': ruby['name']})
+```
+
+## Claude Code Plugin
+
+When used as a Claude Code plugin, this package provides:
+
+### Commands
+
+- `/crystal-svg` - Generate crystal structure visualizations
+- `/identify-gem` - Interactive gemstone identification workflow
+
+### Agents
+
+Expert agents for domain-specific tasks:
+- `crystallography-expert` - Crystal systems, symmetry, Miller indices
+- `gemmology-expert` - Gemstone properties, FGA data
+- `cdl-expert` - CDL syntax and parsing
+
+### Skills
+
+Reference skills covering FGA curriculum topics:
+- Physical properties (hardness, SG, cleavage)
+- Optical properties (RI, birefringence, dispersion)
+- Inclusions and fingerprints
+- Treatments and enhancements
+- Synthetics and simulants
+- Origin determination
+
+## CDL Syntax Overview
+
+Crystal Description Language (CDL) provides precise control over crystal morphology:
+
+```
+system[point_group]:{form}@distance + {form}@distance
+```
+
+Examples:
+```
+cubic[m3m]:{111}                    # Octahedron
+cubic[m3m]:{111}@1.0 + {100}@1.3    # Truncated octahedron
+trigonal[-3m]:{10-10}@1.0 + {0001}@0.5  # Quartz prism
+```
+
+## Component Packages
+
+This plugin integrates:
+
+| Package | Description |
+|---------|-------------|
+| [cdl-parser](https://github.com/gemmology-dev/cdl-parser) | CDL parsing and validation |
+| [mineral-database](https://github.com/gemmology-dev/mineral-database) | Gemstone property database |
+| [crystal-geometry](https://github.com/gemmology-dev/crystal-geometry) | 3D geometry generation |
+| [crystal-renderer](https://github.com/gemmology-dev/crystal-renderer) | Visualization and export |
+| [cdl-lsp](https://github.com/gemmology-dev/cdl-lsp) | Language server (optional) |
+
+## Development
+
+```bash
+git clone https://github.com/gemmology-dev/gemmology-plugin
+cd gemmology-plugin
+pip install -e ".[dev]"
+pytest tests/ -v
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## Links
+
+- [Documentation](https://gemmology.dev/docs)
+- [CDL Specification](https://gemmology.dev/cdl)
+- [GitHub Repository](https://github.com/gemmology-dev/gemmology-plugin)

gemmology_plugin-1.0.0/pyproject.toml

@@ -0,0 +1,89 @@
+[project]
+name = "gemmology-plugin"
+version = "1.0.0"
+description = "Claude Code plugin for coloured gemstone expertise and crystal visualization"
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.10"
+authors = [
+    { name = "Fabian Schuh", email = "fabian@gemmology.dev" }
+]
+keywords = [
+    "gemmology",
+    "crystallography",
+    "gemstones",
+    "visualization",
+    "claude-code",
+    "plugin"
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering",
+]
+dependencies = [
+    "gemmology-cdl-parser>=1.0.0",
+    "gemmology-mineral-database>=1.0.0",
+    "gemmology-crystal-geometry>=1.0.0",
+    "gemmology-crystal-renderer>=1.0.0",
+]
+
+[project.urls]
+Homepage = "https://gemmology.dev"
+Documentation = "https://gemmology.dev/docs"
+Repository = "https://github.com/gemmology-dev/gemmology-plugin"
+Issues = "https://github.com/gemmology-dev/gemmology-plugin/issues"
+
+[project.scripts]
+gemmology = "gemmology_plugin.cli:main"
+crystal-svg = "gemmology_plugin.cli:crystal_svg"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+    "ruff>=0.1.0",
+    "mypy>=1.0"
+]
+lsp = [
+    "gemmology-cdl-lsp>=1.0.0"
+]
+all = [
+    "gemmology-cdl-lsp>=1.0.0",
+]
+
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+gemmology_plugin = ["py.typed"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "W", "F", "I", "B", "C4", "UP"]
+ignore = ["E501"]
+
+[tool.mypy]
+python_version = "3.10"
+strict = false  # Integration layer with evolving APIs
+ignore_missing_imports = true
+check_untyped_defs = true
+disable_error_code = ["attr-defined", "call-arg", "arg-type", "assignment", "type-arg"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-v --tb=short"

gemmology_plugin-1.0.0/setup.cfg

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

gemmology_plugin-1.0.0/src/gemmology_plugin/__init__.py

@@ -0,0 +1,200 @@
+"""
+Gemmology Plugin - Claude Code plugin for coloured gemstone expertise.
+
+This package provides comprehensive tools for gemmology and crystallography,
+including crystal structure visualization, gemstone identification, and
+FGA-curriculum aligned reference materials.
+
+Example:
+    Generate a crystal visualization:
+
+    >>> from gemmology_plugin import generate_crystal_svg
+    >>> svg = generate_crystal_svg("cubic[m3m]:{111}")
+
+    Get preset information:
+
+    >>> from gemmology_plugin import get_preset
+    >>> ruby = get_preset("ruby")
+    >>> print(ruby.ri)
+    '1.762-1.770'
+"""
+
+__version__ = "1.0.0"
+__author__ = "Fabian Schuh"
+__email__ = "fabian@gemmology.dev"
+
+# Re-export core functionality from component packages
+from cdl_parser import (
+    CRYSTAL_SYSTEMS,
+    NAMED_FORMS,
+    POINT_GROUPS,
+    TWIN_LAWS,
+    CrystalDescription,
+    CrystalForm,
+    MillerIndex,
+    Modification,
+    parse_cdl,
+    validate_cdl,
+)
+from crystal_geometry import (
+    CrystalGeometry,
+    cdl_to_geometry,
+    halfspace_intersection_3d,
+)
+from crystal_renderer import (
+    generate_cdl_svg,
+    generate_geometry_svg,
+    geometry_to_gltf,
+    geometry_to_stl,
+)
+from mineral_database import (
+    Mineral,
+    get_preset,
+    search_presets,
+)
+from mineral_database import (
+    list_preset_categories as list_categories,
+)
+
+__all__ = [
+    # Version info
+    "__version__",
+    # CDL Parser
+    "parse_cdl",
+    "validate_cdl",
+    "CrystalDescription",
+    "CrystalForm",
+    "MillerIndex",
+    "Modification",
+    "CRYSTAL_SYSTEMS",
+    "POINT_GROUPS",
+    "TWIN_LAWS",
+    "NAMED_FORMS",
+    # Crystal Geometry
+    "cdl_to_geometry",
+    "CrystalGeometry",
+    "halfspace_intersection_3d",
+    # Mineral Database
+    "get_preset",
+    "search_presets",
+    "Mineral",
+    "list_categories",
+    # Crystal Renderer
+    "generate_cdl_svg",
+    "generate_geometry_svg",
+    "geometry_to_stl",
+    "geometry_to_gltf",
+]
+
+
+def generate_crystal_svg(
+    cdl: str,
+    *,
+    elevation: float = 30.0,
+    azimuth: float = -45.0,
+    show_axes: bool = True,
+    show_grid: bool = True,
+    info_properties: dict = None,
+) -> str:
+    """
+    Generate an SVG visualization of a crystal from CDL notation.
+
+    This is a convenience function that combines parsing, geometry generation,
+    and rendering in a single call.
+
+    Args:
+        cdl: Crystal Description Language string (e.g., "cubic[m3m]:{111}")
+        elevation: View elevation angle in degrees
+        azimuth: View azimuth angle in degrees
+        show_axes: Whether to show crystallographic axes
+        show_grid: Whether to show background grid
+        info_properties: Dict of properties to show in info panel
+
+    Returns:
+        SVG string
+
+    Example:
+        >>> svg = generate_crystal_svg("cubic[m3m]:{111}@1.0 + {100}@1.3")
+        >>> with open("crystal.svg", "w") as f:
+        ...     f.write(svg)
+    """
+    import os
+    import tempfile
+
+    with tempfile.NamedTemporaryFile(suffix=".svg", delete=False) as f:
+        output_path = f.name
+
+    try:
+        generate_cdl_svg(
+            cdl,
+            output_path,
+            elev=elevation,
+            azim=azimuth,
+            show_axes=show_axes,
+            show_grid=show_grid,
+            info_properties=info_properties,
+        )
+        with open(output_path) as f:
+            return f.read()
+    finally:
+        if os.path.exists(output_path):
+            os.unlink(output_path)
+
+
+def generate_preset_svg(
+    preset_name: str,
+    *,
+    elevation: float = 30.0,
+    azimuth: float = -45.0,
+    show_axes: bool = True,
+    show_grid: bool = True,
+    info_panel: bool = True,
+) -> str:
+    """
+    Generate an SVG visualization of a preset gemstone.
+
+    Args:
+        preset_name: Name of the preset (e.g., "diamond", "ruby", "emerald")
+        elevation: View elevation angle in degrees
+        azimuth: View azimuth angle in degrees
+        show_axes: Whether to show crystallographic axes
+        show_grid: Whether to show background grid
+        info_panel: Whether to include FGA info panel (default True for presets)
+
+    Returns:
+        SVG string
+
+    Example:
+        >>> svg = generate_preset_svg("diamond", info_panel=True)
+    """
+    preset = get_preset(preset_name)
+    if preset is None:
+        raise ValueError(f"Unknown preset: {preset_name}")
+
+    # Get CDL string from preset dict
+    cdl = preset.get('cdl')
+    if not cdl:
+        raise ValueError(f"Preset '{preset_name}' has no CDL definition")
+
+    # Build info properties from preset if info_panel is True
+    info_props = None
+    if info_panel:
+        info_props = {
+            'name': preset.get('name', preset_name),
+            'chemistry': preset.get('chemistry'),
+            'system': preset.get('system'),
+            'hardness': preset.get('hardness'),
+            'ri': preset.get('ri'),
+            'sg': preset.get('sg'),
+        }
+        # Remove None values
+        info_props = {k: v for k, v in info_props.items() if v is not None}
+
+    return generate_crystal_svg(
+        cdl,
+        elevation=elevation,
+        azimuth=azimuth,
+        show_axes=show_axes,
+        show_grid=show_grid,
+        info_properties=info_props,
+    )