-
Notifications
You must be signed in to change notification settings - Fork 1
README: add status badges, navigable TOC, and sync repository tree with current layout #55
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,29 @@ | ||
| # CuraFrame: Constraint-Driven Therapeutic Design Reasoning | ||
|
|
||
| [](https://github.com/dfeen87/CuraFrame/actions/workflows/ci.yml) | ||
|  | ||
| [](LICENSE) | ||
|
|
||
| ## Table of Contents | ||
| - [Abstract](#abstract) | ||
| - [Overview](#overview) | ||
| - [Key Features](#key-features) | ||
| - [Repository Structure](#repository-structure) | ||
| - [Theoretical Foundation](#theoretical-foundation) | ||
| - [Installation](#installation) | ||
| - [Usage](#usage) | ||
| - [Advanced Example: CardiAnx-1 Dual-Domain Evaluation](#advanced-example-cardianx-1-dual-domain-evaluation) | ||
| - [Use Cases](#use-cases) | ||
| - [Testing and Validation](#testing-and-validation) | ||
| - [Documentation](#documentation) | ||
| - [Contributing](#contributing) | ||
| - [License](#license) | ||
| - [Citation and Attribution](#citation-and-attribution) | ||
| - [Related Work and Scientific Context](#related-work-and-scientific-context) | ||
| - [Design Philosophy Summary](#design-philosophy-summary) | ||
| - [Concluding Remarks](#concluding-remarks) | ||
| - [Acknowledgments](#acknowledgments) | ||
|
|
||
| --- | ||
|
|
||
| ## Abstract | ||
|
|
@@ -101,49 +125,52 @@ Zero external dependencies in the core engine ensures: | |
| ## Repository Structure | ||
| ``` | ||
| CuraFrame/ | ||
| ├── cura_frame/ # Core reasoning engine (library) | ||
| │ ├── __init__.py # Public API + metadata | ||
| │ ├── core.py # Constraint evaluation engine | ||
| │ ├── comparators.py # Pure comparison semantics | ||
| │ ├── constraints_library.py # Canonical constraint definitions | ||
| │ └── cli.py # Command-line interface | ||
| │ | ||
| ├── apps/ # Application interfaces | ||
| │ ├── __init__.py # Package metadata | ||
| │ ├── __main__.py # Module launcher | ||
| │ ├── console_streamlit/ # Streamlit interactive console | ||
| │ │ └── app.py # Constraint evaluation UI | ||
| │ └── web/ # FastAPI web application | ||
| │ ├── __init__.py | ||
| │ ├── main.py # Routes, authentication, calculator | ||
| │ └── templates/ # Jinja2 HTML templates | ||
| │ | ||
| ├── pipelayer/ # Heavy machinery governance domain | ||
| │ ├── __init__.py | ||
| │ ├── pipelayer.py # PipelayerGovernor and telemetry types | ||
| │ └── test_pipelayer_usage.py | ||
| │ | ||
| ├── tests/ # Test suite | ||
| │ ├── test_core.py # Core engine, CLI, and constraint tests | ||
| │ └── test_web.py # Web application tests | ||
| │ | ||
| ├── docs/ # Constitutional documentation | ||
| │ ├── PHILOSOPHY.md # Core principles | ||
| │ ├── CONSTRAINT_REASONING.md # Technical approach | ||
| │ ├── POPULATION_STRATIFICATION.md | ||
| │ ├── LIMITATIONS.md # Explicit boundaries | ||
| │ ├── ETHICAL_USE.md # Usage constraints | ||
| │ └── INSPIRATION.md # Scientific origins | ||
| │ | ||
| ├── launch_console.py # Root-level Streamlit launcher | ||
| ├── render.yaml # Render.com deployment configuration | ||
| ├── requirements.txt # Python dependencies | ||
| ├── setup.py # Package setup script | ||
| ├── pyproject.toml # Build configuration | ||
| ├── pytest.ini # Test configuration | ||
| ├── CITATION.cff # Software citation metadata | ||
| ├── README.md # This file | ||
| └── LICENSE # Non-Commercial License | ||
| ├── cura_frame/ # Core reasoning engine (library) | ||
| │ ├── core.py # Constraint evaluation engine | ||
| │ ├── constraints_library.py # Canonical constraint definitions | ||
| │ ├── bundles.py # Bundle registry helpers | ||
| │ ├── comparators.py # Comparator semantics | ||
| │ ├── db.py # SQLite-backed auth/user helpers | ||
| │ └── cli.py # Command-line interface | ||
| ├── apps/ # Application interfaces | ||
| │ ├── console_streamlit/ # Streamlit interactive console | ||
| │ │ ├── app.py | ||
| │ │ └── db_auth.py | ||
| │ └── web/ # FastAPI web application | ||
| │ ├── main.py | ||
| │ ├── api/ | ||
| │ ├── core/ | ||
| │ ├── db/ | ||
| │ └── templates/ | ||
|
Comment on lines
+135
to
+144
|
||
| ├── constraints/ # Domain constraint datasets (JSON) | ||
| │ ├── anti_infective/ | ||
| │ ├── cardiac/ | ||
| │ ├── cns/ | ||
| │ ├── formulation/ | ||
| │ ├── hepatic/ | ||
| │ ├── immunologic/ | ||
| │ ├── metabolic/ | ||
| │ ├── oncology/ | ||
| │ ├── pkpd/ | ||
| │ ├── renal/ | ||
| │ ├── safety/ | ||
| │ └── systemic_exposure/ | ||
| ├── simulations/candidates/ # Example candidate payloads | ||
| ├── pipelayer/ # Sideboom pipelayer governance domain | ||
| ├── constraint_core/ # C++ constraint core headers | ||
| ├── scoring/ # C++ scoring engine components | ||
| ├── docs/ # Philosophical + technical documentation | ||
| ├── tests/ # Unit/integration test suite | ||
| ├── CMakeLists.txt # C++ build configuration | ||
| ├── launch_console.py # Root-level Streamlit launcher | ||
| ├── render.yaml # Render deployment configuration | ||
| ├── requirements.txt # Python dependencies | ||
| ├── pyproject.toml # Python build metadata | ||
| ├── setup.py # Package setup script | ||
| ├── pytest.ini # Test configuration | ||
| ├── CITATION.cff # Software citation metadata | ||
| ├── README.md # This file | ||
| └── LICENSE # Non-Commercial license | ||
| ``` | ||
|
|
||
| ### Architectural Intent | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The repository tree claims
cura_frame/contains only the listed modules, butcura_frame/__init__.pyexists in the repo. Since this PR is aiming to keep the tree in sync with the actual layout, either add__init__.pyto the tree or explicitly note that the listing is non-exhaustive.