6keys

A neural consciousness framework (六鑰臨界) based on critical transition theory and topological indicators.

https://github.com/orcaguru/6keys

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.1%) to scientific vocabulary

Keywords

consciousness criticality framework manifold neural-manifold neuroscience open-science ricci-flow thermodynamics topology
Last synced: 6 months ago · JSON representation ·

Repository

A neural consciousness framework (六鑰臨界) based on critical transition theory and topological indicators.

Basic Info
  • Host: GitHub
  • Owner: orcaguru
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 2.7 MB
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 4
Topics
consciousness criticality framework manifold neural-manifold neuroscience open-science ricci-flow thermodynamics topology
Created 8 months ago · Last pushed 8 months ago
Metadata Files
Readme Changelog Contributing License Citation

README.md

Six Keys Criticality ()

A Neural Consciousness State Analysis Framework Based on Critical Transition Theory

License: BSD 3-Clause Python 3.8+ Documentation Status Docker Conda

**** | Paper Download

** PDF**
** English Paper PDF Download**
** ()**

**** | Quick Navigation

| | | | |---------|---------|------| | **** | | 5 | | **** | | | | **** | API | | | **** | | |

** *: | English Docs | * **:


For English Visitors

Welcome! This project provides comprehensive English documentation.

| User Type | Recommended Path | Description | |-----------|------------------|-------------| | New Users | Quick Start FAQ Q&A Collection | 5-minute getting started guide | | Researchers | Complete Paper Mathematical Derivations In-depth Q&A | In-depth theoretical background | | Developers | API Docs Developer Guide | Technical implementation details | | Experimenters | Experiment Guide Visualization Tutorial | Experimental design methods |

** English Documentation Hub: English Docs Center | ** Main Navigation: All Documentation | ** GitBook Documentation**: GitBook Center

Six Keys Criticality -

| | | | |------|------|------| | **** | FELC | (Free Energy Limit Cycle) | | **** | TEB | - (Thermodynamic Efficiency Balance) | | **** | RFI | Ricci (Ricci Flow Index) | | **** | ECGP | (Effective Causal Graph Percolation) | | **** | PWC | (Phase-Wrapped Circulation) | | **** | ACI | - (Astrocyte-Coupling Index) |

| Core Q&A Preview


Q1: **A:** - ****SO(7)6 - **** - ****
Q2: **A:** 1. ** (FELC)** - 2. ** (ACI)** - - 3. ** (ECGP)** - 4.
Q3: **A:** - **** () - **** () - **** ()
Q4: **A:** - **** D_w - **** - ****

** ** - 26

** **: GitBook -

| Quick Start

```bash

pip

pip install sixkeys

git clone https://github.com/isyanghou/6Keys.git cd 6Keys && pip install -e . ```

```python import numpy as np from sixkeys import SixKeysAnalyzer

analyzer = SixKeysAnalyzer() data = np.random.randn(1000, 64) # results = analyzer.analyze(data)

for key, value in results.items(): print(f"{key}: {value:.4f}") ```

****: | | API

| Key Features

| Core Indicators

  • FELC (): | Free Energy Limit Cycle Analysis
  • TEB (): - | Thermodynamic Efficiency Balance
  • RFI (): Ricci | Ricci Flow Index
  • ECGP (): | Effective Causal Graph Percolation
  • PWC (): | Phase-Wrapped Circulation
  • ACI (): - | Astrocyte-Coupling Index

| Analysis Tools

  • ****: (CTM) | Unified framework with Critical Transition Manifold
  • ****: | Multi-state analysis (awake, sedation, anesthesia)
  • ****: | Temporal evolution and critical transition tracking
  • ****: | Statistical validation and significance testing

| Visualization Features

  • ****: | Radar charts for six-dimensional indicator space
  • ****: | Phase diagrams for critical state trajectories
  • ****: | Time series analysis for dynamic evolution
  • ****: | Statistical plots (boxplots, distributions, etc.)

| Technical Features

  • ****: Windows, macOS, Linux | Multi-platform support
  • ****: Docker Docker Compose | Containerized deployment
  • ****: | Batch processing for large datasets
  • ****: | Extensible modular design
  • ****: BSD 3-Clause | Open source with BSD 3-Clause license

| Project Structure

sixkeys/ sixkeys/ # Python core/ # (-) analysis/ # demos/ # docs/ # gitbook/ # GitBook paper-zh/ # paper-en/ # English complete paper qa-zh/ # qa-en/ # English Q&A zh/paper/ # () en/paper/ # English complete paper () api/ # API examples/ # tests/ #

****:

| Theoretical Background

****: | | GitBook

| Visualization Demos

```bash

python examples/demo_visualization.py

pip install matplotlib seaborn scipy pandas ```

*: - * - - **** - - **** -

****:

| Six Keys Q&A Collection

** ** -

** GitBook ** -

  • ** 26** -
  • ** ** -
  • ** ** -
  • ** ** - Python
  • ** ** -

| | | | |------|----------|----------| | ** ** | Q1-Q10 | | | ** ** | Q11-Q20 | | | ** ** | Q21-Q26 | |

****: Q1


| Documentation & Tutorials

| Quick Access by Needs

****: 1. [ ](docs/quickstart.md) - 5 2. [ ](docs/installation.md) - 3.2. [ ](docs/gitbook/qa-zh/Six-Keys_Criticality_QA.md) - 4. [ ](docs/faq.md) - 5. [ ](docs/visualization.md) - ** ** [ FAQ](docs/faq.md) | [ ](mailto:isyanghou@gmail.com)
****: 1. [ ](docs/theory.md) - 2. [ ](docs/gitbook/qa-zh/Six-Keys_Criticality_QA.md) - 3. [ ](docs/gitbook/paper-zh/) - 4. [ ](docs/gitbook/paper-zh/A-0_.md) - 5. [ ](docs/experiments.md) - ** **: [ English Paper](docs/gitbook/paper-en/) | [ English Q&A](docs/gitbook/qa-en/Six-Keys_Criticality_QA.md)
****: 1. [ API](docs/api/) - API 2. [ ](docs/developers.md) - 3. [ ](docs/project-structure.md) - 4. [ ](docs/developers.md#) - ** **: [GitHub](https://github.com/isyanghou/6Keys) | [Issues](https://github.com/isyanghou/6Keys/issues)

| Core Documentation

| | | | |---------|------|----------| | **** | | | | **** | | English | | | **** | | English Q&A | | | GitBook | | | | API | | | | **** | FAQ | |

****: -

*GitBook *: GitBook -

| Contributing

CONTRIBUTING.md

```bash

git clone https://github.com/isyanghou/6Keys.git cd 6Keys && pip install -e ".[dev]" pytest tests/ # ```

| Citation

bibtex @software{sixkeys2025, title={Six Keys Criticality: A Framework for Neural Consciousness State Analysis}, author={Hou, You Yang}, year={2025}, url={https://github.com/isyanghou/6Keys}, note={ORCID: 0009-0000-7041-8574} }

| License

| Author

You Yang Hou
isyanghou@gmail.com | ORCID: 0009-0000-7041-8574



Owner

  • Name: Yang Hou
  • Login: orcaguru
  • Kind: user

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.1.0
title: Six Keys Criticality: A Framework for Neural Consciousness State Analysis
message: "If you use this software, please cite it as below."
type: software
authors:
  - family-names: Hou
    given-names: Yang
    orcid: 'https://orcid.org/0009-0000-7041-8574'
identifiers:
  - type: doi
    value: '10.5281/zenodo.15805818'
  - type: url
    value: 'https://github.com/isyanghou/6Keys'
repository-code: 'https://github.com/isyanghou/6Keys'
url: 'https://github.com/isyanghou/6Keys'
abstract: >
  Six Keys Criticality is an innovative neuroscience
  theoretical framework that quantifies and analyzes
  critical state transitions in neural systems through
  six key indicators (ζ₁-ζ₆). This project provides a
  complete Python implementation supporting the full
  workflow from theoretical modeling to actual data
  analysis.
keywords:
  - neuroscience
  - consciousness
  - criticality
  - neural-networks
  - brain-analysis
  - hopf-oscillator
  - information-theory
  - complex-systems
  - phase-transitions
  - neural-dynamics
license: BSD-3-Clause
commit: main
version: v1.2.0
date-released: '2025-07-04'

GitHub Events

Total
Last Year

Dependencies

Dockerfile docker
  • python 3.9-slim build
docker-compose.yml docker
environment.yml pypi
  • bokeh >=2.4.0
  • numba >=0.56.0
  • plotly >=5.0.0
  • sixkeys *
pyproject.toml pypi
  • matplotlib >=3.5.0
  • networkx >=2.6
  • numpy >=1.21.0
  • pandas >=1.3.0
  • pyyaml >=6.0
  • scikit-learn >=1.0.0
  • scipy >=1.7.0
  • tqdm >=4.62.0
requirements.txt pypi
  • matplotlib >=3.5.0
  • networkx >=2.6
  • numba >=0.56.0
  • numpy >=1.21.0
  • pandas >=1.3.0
  • pyyaml >=6.0
  • scikit-learn >=1.0.0
  • scipy >=1.7.0
  • seaborn >=0.11.0
  • statsmodels >=0.13.0
  • tqdm >=4.62.0
setup.py pypi