Installation

How to install hidden-attractors-fo from GitHub or PyPI.

Requirements

  • Python 3.11+
  • numpy ≥ 1.26, matplotlib ≥ 3.8 (installed automatically)
  • Optional: scipy, nolds, antropy for extended analysis
  • Optional: gcc on PATH for native C backends (see Platform Notes)

Install from GitHub

The package is currently in research alpha. Install directly from the repository:

git clone https://github.com/Xerkkun/Hidden-Attractors-Localization.git
cd Hidden-Attractors-Localization/version_2
pip install -e .

The -e flag installs in editable mode, so changes to the source are reflected immediately.

Development Install

For running tests and benchmarks:

pip install -e ".[dev]"

This adds pytest, pytest-cov, and pytest-benchmark.

Analysis Extras

For Lyapunov exponents via nolds and entropy measures via antropy:

pip install -e ".[analysis]"

Documentation Build

To build these docs locally with MkDocs:

pip install -e ".[docs]"
python -m mkdocs serve

Legacy Scripts

Historical research scripts available as CLI commands:

pip install -e ".[legacy]"

Verify Installation

import hidden_attractors
print(hidden_attractors.__version__)  # 0.1.0

from hidden_attractors import list_registered_systems
print(list_registered_systems())
# ['chua-nonsmooth', 'chua-arctan', 'lorenz', 'rossler']

PyPI

The package is not yet on PyPI. Track the issue on GitHub.

Next Steps