API Reference

Stability tiers and comprehensive Python API reference.

The hidden-attractors-fo library strives to provide a stable and predictable Python API for researchers.

API Stability Tiers

Modules and functions in this library fall into one of three stability tiers:

🟢 Public Tier

Stable. These interfaces are the primary way to interact with the library. They are guaranteed not to break backwards compatibility within the same major version number (e.g., 1.x.x).

  • hidden_attractors.workflows.*
  • hidden_attractors.models.*
  • hidden_attractors.solvers.*
  • hidden_attractors.basins.classify_basin

🟡 Provisional Tier

Subject to change. These are newer analytical tools or integrations that are still being refined. Their signatures might change in minor version updates (e.g., 1.1 to 1.2).

  • hidden_attractors.analysis.spectral_entropy
  • hidden_attractors.analysis.lyapunov_rosenstein
  • hidden_attractors.seed_generation.machado_seeds

🔴 Internal Tier

No guarantees. Any module, function, or variable prefixed with an underscore (e.g., _stability.py, _native_compiler()) is strictly for internal library use. Do not rely on these in your scripts, as they can be removed or modified in patch releases without warning.

Module References

Select a module below to view its complete API documentation: