Repository Structure Guide

💎 NYEIN PROJECT: SLEF - Structural-Logic Extraction Framework

🌟 Overview: Wisdom-Driven Computational Linguistics

The Nyein Project is a groundbreaking initiative focused on the perpetual protection and deep philosophical extraction of the Burmese language's cultural logic. Our core principle is enforcing Wisdom and Societal Harmony (Digital Bodhisattva) within AI decisions, rather than prioritizing raw efficiency.

📁 Repository Structure Guide

This repository is organized according to standard Python project practices to ensure clarity and maintainability.

Folder	Purpose	Key File Types
modules/	Core NSTF/SLEF Source Code (Python Logic)	.py
data/	Ontologies, Schemas, and Essential Data	.json, .csv, .tsv
docs/	Technical Whitepapers, Logic Explanation, Concepts	.md
examples/	Practical Usage Demos, Tutorials, Proofs-of-Concept	.py, .md
tests/	Automated Test Cases for Logic Verification	.py
tools/	Standalone Utility Scripts for Maintenance/Deployment	.py, .sh
notes/ (သို့မဟုတ် source_notes/)	သုတေသန မှတ်စုများ၊ စမ်းသပ်မှုများ၊ ကိုးကားချက်များ	.md, .txt, .tsv

🚀 Getting Started

1. Read the Logic: Start with the NSTF Ethical Decision Engine Logic for a deep dive into the framework's philosophy.
2. Explore the Code: The main system entry point is located in modules/nstf_engine/main_system.py.
3. Run Demos: See practical applications in the examples/ folder.

NOTE: This project is governed by the Nyein Academic Use License (NAUL).

💻 Core Logic Modules (modules/)

This folder contains the Source Code for the Structural-Logic Extraction Framework (SLEF) and the Neural-Symbolic Transformative Framework (NSTF).

📝 Folder Purpose

All functional Python code that runs the core logic of the Nyein Project must reside here. This includes:

1. nstf_engine/: The 4-Stage Analysis Pipeline and core components.
2. Myanmar Language Tokenization System.
3. API Endpoints and Service Logic.

⚠️ Important Rules

• File Type: MUST be .py (Python scripts).
• NO Documentation: Do not place Markdown (.md) or simple text files here. All explanations belong in the docs/ folder.
• NO Data Files: Data files (like .json or .tsv) must be placed in the data/ folder.

📊 Core Data Files (data/)

This folder is the central repository for all essential, structured data files used by the NSTF/SLEF core engine.

📝 Folder Purpose

Data here is used to directly power the framework's logic. Examples include:

• Ontologies: T-Codes, Philosophical Dimensions.
• Schemas: Ethical Engine rule structures.
• Static Reference Data: Large linguistic datasets.

⚠️ Important Rules

• File Types: .json, .tsv, .csv, .yaml (Structured Data only).
• NO Source Code: Python files (.py) are strictly prohibited here; they belong in the modules/ folder.
• Data Integrity: Changes to these files must follow a strict review process as they directly affect the framework's deterministic ethical guidance.
• Key Files:
  • ultimate_ethical_engine.json (The Core Schema)
  • t_codes_ontology.json (T-Code Definitions)

📚 Documentation and Concepts (docs/)

This folder holds all non-code, technical, philosophical, and architectural explanations for the Nyein Project.

📝 Folder Purpose

Documentation helps contributors and users understand the "Why" and "How" of the framework. Key contents include:

• Whitepapers: Final Launch Whitepaper, Technical Summary (../docs/NYEIN_PROJECT_TECHNICAL_SUMMARY.md).
• Core Logic: In-depth explanation of the NSTF/SLEF philosophical and mathematical models (../docs/ethical_decision_engine_logic.md).
• Conceptual Mapping: Diagrams and schemas explaining data flows and relationships.

⚠️ Important Rules

• File Types: MUST be .md (Markdown) or other readable text formats (.txt, .pdf - ရှားရှားပါးပါး).
• NO Code: Python Code (.py) is not allowed.
• Linking: All major Markdown files in this folder should be linked from the main README.md in the root directory for easy access.

🧪 Test Suite (tests/)

This folder contains unit tests and integration tests to verify the correctness and reliability of the NSTF/SLEF logic.

📝 Folder Purpose

Testing is critical to ensure the deterministic ethical guidance is consistently maintained.

• Unit Tests: Verify individual components (e.g., T-Code calculation, Fo/Ma energy balance) work correctly.
• Integration Tests: Verify the complete 4-Stage Analysis Pipeline functions as expected.
• Compliance Tests: Specific tests to verify adherence to the 15 Immutable Missions.

⚠️ Important Rules

• File Type: MUST be .py (Python test scripts, typically using frameworks like unittest or pytest).
• Naming Convention: Test files should ideally start with test_ (e.g., test_scenarios.py).
• NO Production Code: Only test files are allowed here. Core logic files belong in modules/.