Welcome to PolyHex’s documentation!

Installation:

Run

$ pip install polyhex

Table of Contents

Contents:

• Decorators
  • hex_coord_system_dependent()
  • top_dependent()
  • vertex_orientation_dependent()
• Edges
  • HexagonEdge
    • HexagonEdge.distance()
    • HexagonEdge.draw()
    • HexagonEdge.encoding
    • HexagonEdge.end
    • HexagonEdge.feature
    • HexagonEdge.hexagon
    • HexagonEdge.index
    • HexagonEdge.render()
    • HexagonEdge.render_line()
    • HexagonEdge.render_triangle()
    • HexagonEdge.start
• Hexagons
  • Hexagon
    • Hexagon.add_token()
    • Hexagon.adjency
    • Hexagon.assets
    • Hexagon.distance()
    • Hexagon.draw()
    • Hexagon.edge_feature
    • Hexagon.encoding
    • Hexagon.get_edge_adjency()
    • Hexagon.get_vertex_adjency()
    • Hexagon.hex_coord
    • Hexagon.hex_coord_system
    • Hexagon.hexagon_feature
    • Hexagon.is_compatible()
    • Hexagon.radius
    • Hexagon.render()
    • Hexagon.token
    • Hexagon.top
    • Hexagon.vertex_feature
    • Hexagon.vertex_orientation
• Nodes
  • HexagonCentre
    • HexagonCentre.__init__()
    • HexagonCentre.distance()
  • HexagonVertex
    • HexagonVertex.__init__()
    • HexagonVertex.distance()
• Polyhexes
  • Polyhex
    • Polyhex.append_hex()
    • Polyhex.assets
    • Polyhex.create_from_iterable()
    • Polyhex.create_from_number()
    • Polyhex.create_spiral()
    • Polyhex.create_tiling()
    • Polyhex.draw()
    • Polyhex.hex_coord_system
    • Polyhex.placeholder_hex()
    • Polyhex.radius
    • Polyhex.render()
    • Polyhex.top
    • Polyhex.vertex_orientation
• PyG Exporter
  • PyGExporter
    • PyGExporter.export_graph()
    • PyGExporter.export_graphs()
    • PyGExporter.template_exporter()
• Graph Module
  • EdgeBorderGraph
    • EdgeBorderGraph.add()
    • EdgeBorderGraph.append()
    • EdgeBorderGraph.remove()
  • EdgeGraph
    • EdgeGraph.append()
  • Graph
    • Graph.__init__()
    • Graph.append()
    • Graph.sample()
  • HexagonBorderGraph
    • HexagonBorderGraph.add()
    • HexagonBorderGraph.append()
  • HexagonGraph
    • HexagonGraph.append()
  • VertexGraph
    • VertexGraph.append()