Metadata-Version: 2.4
Name: prime-link-knot-10
Version: 0.1.1
Summary: table for prime link and knot under 10 crossing.
License: MIT
License-File: LICENSE
Author: GGN_2015
Author-email: premierbob@qq.com
Requires-Python: >=3.10
Classifier: License :: OSI Approved :: MIT License
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: Programming Language :: Python :: 3.14
Requires-Dist: link-rep (>=0.0.4)
Description-Content-Type: text/markdown

# prime-link-knot-10

Provide the prime knot and link catalogue used by the TopLink generator.

## Installation

```bash
pip install prime-link-knot-10
```

## Usage example

```python
import prime_link_knot_10

catalogue = prime_link_knot_10.load_pd_code()
print(catalogue["K3a1"])
print(prime_link_knot_10.get_all_prime_under10()[:5])
print("K4a1" in prime_link_knot_10.load_amphicheiral())
```

## Algorithm

Package data is loaded once and cached. PD records from knot, link, mirror, and non-mirror tables are merged into one dictionary. Mirror duplicates of amphicheiral objects are omitted. Names are sorted structurally by crossing number, object type, alternating class, table index, and mirror status. A depth-first multiset enumeration supplies all prime-factor combinations up to a crossing bound.

## Input conventions

A PD code is represented as a list of four-entry crossings. Arc labels normally occur exactly twice. Public functions validate inputs and return new values rather than mutating caller-owned data unless their API explicitly says otherwise.

## External software

No external software is required. All catalogue files are included in the wheel and sdist.

## Development

Run examples and package checks before release. Python packages require Python 3.10 or newer. Build PyPI artifacts with:

```bash
poetry check
poetry build
```

## License

MIT. See `LICENSE`.

