ePT Documentation¶
ePT is an open-source proficiency testing system for laboratory quality assurance. Organisations use it to run PT shipments, collect results from participating laboratories, evaluate those results against reference data, and issue reports.
Where to start¶
The system references use ePT 7.6.21 as their baseline. Deployment facts, approved policies and executed validation evidence remain installation-specific.
| Your goal | Read |
|---|---|
| Understand what ePT is for | About ePT |
| Install ePT on Ubuntu, Docker, or Windows | Install |
| Update a running installation | Update |
| Back up, restore, or move an instance | Backup & recovery |
| Size hardware before buying it | Infrastructure |
Check a server's health, or run maintenance with the ept command |
CLI tools |
| Reset a password, run a migration, refresh translations | CLI tools |
| Learn the admin workflow end to end | Training |
| Understand how the code fits together | Architecture |
| Add or change a test scheme | Schemes |
| Translate the interface or add a language | Translation |
| Get a change reviewed and merged | Engineering standards |
| Complete common administrator and participant tasks | User guide |
| Create, change and review account access | User management |
| Review functional requirements and use cases | Requirements baseline |
| Review security controls and non-functional requirements | Security |
| Understand core records and business fields | Data model and core dictionary |
| Look up SQL types, defaults and nullability | Physical column reference |
| Identify implemented integration routes | API inventory |
| Review locked software packages and license metadata | Software and licenses |
| Prepare acceptance tests and record evidence | Validation package |
| Investigate operational faults | Troubleshooting |
| Review storage locations and cleanup rules | Storage and retention |
| Assemble a deployment evidence package | Deployment handover |
Supported test schemes¶
Seven built-in schemes ship in the scheme_list table, alongside any number of user-configured custom tests. The middle column is the name shown in the admin panel and the participant portal.
| Code | Name in ePT | Description |
|---|---|---|
dts |
Dried Tube Specimen - HIV Serology | Rapid HIV testing with multiple algorithms |
vl |
Dried Tube Specimen - HIV Viral Load | Quantitative viral load testing with Z-score analysis |
eid |
Dried Blood Spot - Early Infant Diagnosis | PCR-based infant HIV testing |
tb |
Dried Tube Specimen - Tuberculosis | Molecular (GeneXpert) and microscopy testing |
recency |
Rapid Test for Recent Infection (RTRI) | Recent infection testing |
covid19 |
SARS-CoV-2 | Multi-platform PCR testing |
dbs |
Dried Blood Spot - HIV Serology | EIA and Western Blot testing |
generic |
Custom Tests | User-configured test types with dynamic fields |
Training curriculum¶
| Document | Audience | Duration |
|---|---|---|
| Overview | All | — |
| Part 1: Setup and participants | Admin | ~10 min |
| Part 2: Surveys and shipments | Admin | ~10 min |
| Part 3: Participant results and reports | Participant | ~5–10 min |
| Part 4: Evaluation, reports, and finalization | Admin | ~10 min |
| Exercise: DTS HIV Serology | All | ~20–30 min |
Key configuration files¶
| File | Purpose |
|---|---|
application/configs/application.ini |
Database, sessions, modules |
constants.php |
Global paths and APP_VERSION |
For the technology stack and hardware sizing, see Infrastructure. For the directory layout, see Architecture. For documentation and code conventions, see Engineering standards.
Support¶
Email amit@deforay.com, or open an issue at deforay/ept.