Repository Layout
Understand the importable package directories, CLI tools, configuration assets, and API boundaries.
To maintain clean package interfaces and separate research legacy scripts from the active active library API, the repository organizes files into clear sub-directories.
Directory Structure
hidden_attractors/ Active importable package
hidden_attractors/systems/ Chaotic-system registry and custom definitions
hidden_attractors/native/csrc/ C sources bundled with the package
examples/ Small, runnable examples
tests/ Pytest and unit test suites
configs/ Validation contract schemas and configuration files
docs/ Markdown source files and documentation assets
validation/ Promoted validation evidence, manifests, and reports
tools/cli/ Maintained terminal CLI commands
tools/legacy/ Historical scripts kept behind command facades
outputs/ Exploratory sweep outputs and generated run data
Public API Boundary
Only the components inside hidden_attractors/, examples/, tests/, configs/, validation/, and documented tools/cli/ console commands are considered active, supported library APIs.
- Research scripts: Legacy scripts under
tools/legacy/are preserved for traceability. You are encouraged to mine them for logic, but any new reusable behavior must be integrated into the core package directory first. - Exploratory runs: Use
outputs/for ordinary generated data. Do not pollutevalidation/with exploratory sweeps; it is strictly reserved for audited evidence promoted by the validation contract auditor.