Polish dashboard UX and update README
- Wrap simulation controls in form to prevent page reruns on change - Fix TempCo test configs to use 2+ temperature points - Add Installation, Quick Start, and usage examples to README 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
75
README.md
75
README.md
@@ -29,11 +29,82 @@ ThermalATE enables offline development of ATE (Automated Test Equipment) charact
|
||||
| [Technical Specification](docs/02_technical_specification.md) | Specifies **how** to implement the system |
|
||||
| [Architecture Decisions](docs/03_architecture_decisions.md) | Explains **why** decisions were made |
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/yourrepo/py_dvt_ate.git
|
||||
cd py_dvt_ate
|
||||
|
||||
# Install with development dependencies
|
||||
pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Interactive Dashboard
|
||||
|
||||
Launch the Streamlit dashboard to visualise the physics simulation and run tests:
|
||||
|
||||
```bash
|
||||
py-dvt-ate dashboard
|
||||
```
|
||||
|
||||
This opens a browser window with:
|
||||
- **Live Simulation** - Real-time temperature/voltage charts with physics coupling
|
||||
- **Test Execution** - Run TempCo characterisation tests
|
||||
- **Results Viewer** - Browse and analyse historical test results
|
||||
|
||||
### CLI Commands
|
||||
|
||||
```bash
|
||||
# Start the simulation server (TCP ports for SCPI instruments)
|
||||
py-dvt-ate serve
|
||||
|
||||
# List available tests
|
||||
py-dvt-ate tests list
|
||||
|
||||
# Run a TempCo test
|
||||
py-dvt-ate tests run tempco --config config/tempco_test.yaml
|
||||
```
|
||||
|
||||
### Programmatic API
|
||||
|
||||
```python
|
||||
from py_dvt_ate.instruments import InstrumentFactory
|
||||
from py_dvt_ate.simulation import SimulationServer
|
||||
|
||||
# Start simulation server
|
||||
server = SimulationServer()
|
||||
server.start()
|
||||
|
||||
# Create instruments via HAL
|
||||
factory = InstrumentFactory()
|
||||
instruments = factory.create_from_config("config/default.yaml")
|
||||
|
||||
# Control instruments using standard interfaces
|
||||
instruments.chamber.set_temperature(85.0)
|
||||
instruments.psu.set_voltage(1, 5.0)
|
||||
instruments.psu.enable_output(1, True)
|
||||
voltage = instruments.dmm.measure_dc_voltage()
|
||||
|
||||
print(f"Output voltage: {voltage:.4f} V")
|
||||
```
|
||||
|
||||
## Project Status
|
||||
|
||||
**Status:** In Development
|
||||
**Status:** MVP Complete (v0.1.0)
|
||||
|
||||
This project is currently being developed. See the requirements document for the full scope and success criteria.
|
||||
The core vertical slice is functional:
|
||||
- Physics engine with thermal-electrical coupling
|
||||
- Virtual instruments (chamber, PSU, DMM)
|
||||
- Hardware Abstraction Layer
|
||||
- SCPI-over-TCP server
|
||||
- Test framework with TempCo test
|
||||
- Streamlit dashboard
|
||||
- SQLite/Parquet data persistence
|
||||
|
||||
See the requirements document for the full scope and future phases.
|
||||
|
||||
## Technology Stack
|
||||
|
||||
|
||||
Reference in New Issue
Block a user