DREDGE — A small Python utility (scaffold).
Project description
DREDGE
DREDGE — small Python package scaffold.
Repository Structure
- src/dredge/ - Python package source code
- tests/ - Test files
- docs/ - Documentation files
- benchmarks/ - Benchmark scripts and results
- swift/ - Swift implementation files
- DREDGE-Cli.xcworkspace - Xcode workspace for Swift development
- archives/ - Archived files (excluded from version control)
Install
Create a virtual environment and install:
python -m venv .venv source .venv/bin/activate # or .venv\Scripts\activate on Windows pip install -e .
Server Usage
DREDGE includes two web servers:
1. DREDGE x Dolly Server (Port 3001)
A web server for API-based interaction with Dolly integration.
Starting the Server
python -m dredge serve
# or
dredge-cli serve --host 0.0.0.0 --port 3001 --debug
API Endpoints
- GET / - API information and available endpoints
- GET /health - Health check endpoint
- POST /lift - Lift an insight with Dolly integration
Example Usage
# Get API info
curl http://localhost:3001/
# Check health
curl http://localhost:3001/health
# Lift an insight
curl -X POST http://localhost:3001/lift \
-H "Content-Type: application/json" \
-d '{"insight_text": "Digital memory must be human-reachable."}'
2. MCP Server (Port 3002) - Quasimoto Integration
A Model Context Protocol server for serving Quasimoto neural wave function models.
Starting the MCP Server
python -m dredge mcp
# or
dredge-cli mcp --host 0.0.0.0 --port 3002 --debug
MCP Protocol Endpoint
- GET / - MCP server capabilities and model information
- POST /mcp - MCP protocol endpoint for model operations
Available Operations
- list_capabilities - List available models and operations
- load_model - Load Quasimoto models (1D, 4D, 6D, ensemble)
- inference - Run inference on loaded models
- get_parameters - Retrieve model parameters
- benchmark - Run performance benchmarks
Example MCP Request
# List capabilities
curl http://localhost:3002/
# Load a model
curl -X POST http://localhost:3002/mcp \
-H "Content-Type: application/json" \
-d '{"operation": "load_model", "params": {"model_type": "quasimoto_1d"}}'
# Run inference
curl -X POST http://localhost:3002/mcp \
-H "Content-Type: application/json" \
-d '{"operation": "inference", "params": {"model_id": "quasimoto_1d_0", "inputs": {"x": [0.5], "t": [0.0]}}}'
Available Models
- quasimoto_1d - 1D wave function (8 parameters)
- quasimoto_4d - 4D spatiotemporal wave function (13 parameters)
- quasimoto_6d - 6D high-dimensional wave function (17 parameters)
- quasimoto_ensemble - Configurable ensemble models
GitHub Codespaces
The repository includes .devcontainer/devcontainer.json configured to automatically forward ports 3001 and 3002 when running in GitHub Codespaces.
Swift Development
DREDGE includes a Swift CLI implementation. You can develop using:
Xcode Workspace
open DREDGE-Cli.xcworkspace
Swift Package Manager
# Build from root
swift build
swift run dredge-cli
# Or build from swift/ directory
cd swift
swift build
swift run dredge-cli
See SWIFT_PACKAGE_GUIDE.md for detailed Swift development information.
Test
Run tests with pytest:
pip install -U pytest pytest
Development
- Edit code in src/dredge
- Update version in pyproject.toml
- Tag releases with v and push tags
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file dredge_cli-0.1.4.tar.gz.
File metadata
- Download URL: dredge_cli-0.1.4.tar.gz
- Upload date:
- Size: 13.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e780432194d2fd3e6c74143be6545c063b7abfd9389f8a4cb044f01416d71a59
|
|
| MD5 |
a4b176d0df0b3f2d0ea16f48810f12e5
|
|
| BLAKE2b-256 |
1effc84925dbd04e4ee2adec1441c5eacbb70e9b3de2114bb2d3c844150fea9a
|
File details
Details for the file dredge_cli-0.1.4-py3-none-any.whl.
File metadata
- Download URL: dredge_cli-0.1.4-py3-none-any.whl
- Upload date:
- Size: 9.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a08627905128e33f2cd33605067ec0ed377593c1511b7b7276768005beb89cbb
|
|
| MD5 |
6bb00ebd12b592cef4b3f485205c006b
|
|
| BLAKE2b-256 |
980db01c56777635e19d2ae4f05a39ad180ae7906d326d647492ed8a6fa65848
|