Skip to main content

3D Stratigraphic Graph Management Library for archaeological and heritage applications

Project description

s3dgraphy

PyPI version Python versions License: GPL v3 Downloads Publish to PyPI

3D Stratigraphic Graph Management Library

s3dgraphy is a Python library for creating and managing multitemporal, 3D knowledge graphs, with a focus on archaeological and heritage applications. It provides tools for stratigraphic data management, temporal modeling, and graph-based analysis of archaeological contexts.

Part of the Extended Matrix Framework, s3dgraphy implements the formal language Extended Matrix (EM) for archaeological documentation and 3D reconstruction workflows.

🚀 Installation

# From PyPI (stable releases)
pip install s3dgraphy

# From TestPyPI (development versions)
pip install --index-url https://test.pypi.org/simple/ s3dgraphy

# With optional dependencies
pip install s3dgraphy[visualization]  # For plotting features
pip install s3dgraphy[full]          # All optional dependencies

🔧 Quick Start

import s3dgraphy

# Create a new stratigraphic graph
graph = s3dgraphy.Graph()

# Add stratigraphic units
us1 = graph.add_node("US001", node_type="US", 
                     properties={"period": "Roman", "material": "pottery"})
us2 = graph.add_node("US002", node_type="US", 
                     properties={"period": "Medieval", "material": "stone"})

# Add stratigraphic relationships
graph.add_edge(us1, us2, edge_type="ABOVE", 
               properties={"certainty": "high"})

# Query the graph
print(f"Graph contains {len(graph.nodes)} stratigraphic units")
print(f"Relationships: {len(graph.edges)}")

# Export to different formats
graph.export_graphml("stratigraphy.graphml")
graph.export_json("stratigraphy.json")

📚 Core Features

🏛️ Archaeological Stratigraphic Modeling

  • Stratigraphic Units (US): Physical layers and contexts
  • Stratigraphic Volumes (USV): 3D spatial representations
  • Surfaces (SF): Interface documentation
  • Temporal Relationships: Before/after, contemporary, uncertain

🔗 Extended Matrix Integration

  • EM Language Support: Full implementation of Extended Matrix formal language
  • Visual Rules: JSON-based styling and visualization rules
  • CIDOC-CRM Mapping: Semantic web compatibility
  • Connection Rules: Automated relationship inference

📊 Graph Operations

  • Multitemporal Analysis: Handle complex temporal sequences
  • Graph Traversal: Navigate stratigraphic relationships
  • Filtering & Querying: Find specific contexts and relationships
  • Validation: Check stratigraphic consistency

💾 Data Exchange

  • GraphML Import/Export: Industry standard graph format
  • JSON/YAML Support: Lightweight data exchange
  • Excel Integration: Tabular data import
  • 3D Model Integration: GLTF/GLB support for 3D contexts

🎯 Use Cases

Archaeological Projects

  • Excavation Documentation: Record stratigraphic sequences
  • Site Analysis: Understand temporal relationships
  • 3D Reconstruction: Link physical evidence to 3D models
  • Publication: Generate stratigraphic matrices and diagrams

Heritage Applications

  • Monument Analysis: Document construction phases
  • Conservation Planning: Track intervention history
  • Virtual Archaeology: Create interactive 3D experiences
  • Research Integration: Connect archaeological data with other disciplines

📖 Documentation

🔧 Development

Setting up Development Environment

# Clone the repository
git clone https://github.com/zalmoxes-laran/s3dgraphy.git
cd s3dgraphy

# Install in development mode
pip install -e .[dev]

# Run tests
pytest

# Run linting
black src/
flake8 src/

Release Process

# Bump version and create tag
bump2version patch  # or minor, major

# Push to GitHub
git push --follow-tags

# Create release on GitHub to auto-publish to PyPI

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Areas for Contribution

  • New Node Types: Archaeological contexts, dating methods
  • Import/Export Formats: Additional data exchange formats
  • Visualization: Enhanced 3D layouts and rendering
  • Analysis Tools: Statistical analysis, pattern recognition
  • Documentation: Examples, tutorials, case studies

🏛️ Extended Matrix Ecosystem

s3dgraphy is part of a larger ecosystem:

📄 License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

The GPL-3.0 license ensures that s3dgraphy remains free and open source, promoting transparency and collaboration in archaeological research and heritage preservation.

🏛️ Citation

If you use s3dgraphy in your research, please cite:

@software{s3dgraphy2024,
  title={s3dgraphy: 3D Stratigraphic Graph Management Library},
  author={Demetrescu, Emanuel},
  year={2024},
  url={https://github.com/zalmoxes-laran/s3dgraphy},
  version={0.1.1},
  institution={CNR-ISPC (National Research Council - Institute of Heritage Science)}
}

👥 Credits

Author & Maintainer: Emanuel Demetrescu (CNR-ISPC)

Institution: National Research Council of Italy - Institute of Heritage Science (CNR-ISPC)

Funding: This research has been supported by various archaeological and heritage preservation projects.

🔗 Links


s3dgraphy - Bringing archaeological stratigraphy into the digital age 🏛️✨

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

s3dgraphy-0.1.38.tar.gz (782.8 kB view details)

Uploaded Source

Built Distribution

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

s3dgraphy-0.1.38-py3-none-any.whl (826.3 kB view details)

Uploaded Python 3

File details

Details for the file s3dgraphy-0.1.38.tar.gz.

File metadata

  • Download URL: s3dgraphy-0.1.38.tar.gz
  • Upload date:
  • Size: 782.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for s3dgraphy-0.1.38.tar.gz
Algorithm Hash digest
SHA256 b13e5207ad54cdcd9315bb9c5f74eedbee2bb6f77ca7a4f7655b960083e3f52d
MD5 dc0d2ad0df04bd79e6244d4ecffe805c
BLAKE2b-256 e723f5d54f50d40e9cb6d747a58c4d109d679fe88497cc4d02234839d7ea9e36

See more details on using hashes here.

File details

Details for the file s3dgraphy-0.1.38-py3-none-any.whl.

File metadata

  • Download URL: s3dgraphy-0.1.38-py3-none-any.whl
  • Upload date:
  • Size: 826.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for s3dgraphy-0.1.38-py3-none-any.whl
Algorithm Hash digest
SHA256 9bd749c96e10f85b0f9c17222be7f36d2a725a602acd134accabbc7c8498831b
MD5 3478f51e3d23f8fae584a004c717f4f7
BLAKE2b-256 da8dd9c74286051e87d5926c4a79a31a917abe3eca9191dc28d3a351670ee001

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