Skip to content

Commit 472d199

Browse files
committed
amends to README to reflect refactor
1 parent 518e28c commit 472d199

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,17 @@
22
[![Coverage](https://codecov.io/gh/DiamondLightSource/smartem-decisions/branch/main/graph/badge.svg)](https://codecov.io/gh/DiamondLightSource/smartem-decisions)
33
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
44

5-
# SmartEM Backend
5+
# SmartEM Decisions
66

77
A comprehensive system for smart data collection and processing in cryo-electron microscopy, designed to optimize acquisition workflows through intelligent decision-making and real-time data analysis.
88

9+
## System Components
10+
11+
- **`smartem_common`**: Shared schemas, types, and utilities used across all components
12+
- **`smartem_api`**: HTTP API client and server functionality for component communication
13+
- **`smartem_backend`**: Core backend service with database operations and message queue processing
14+
- **`smartem_agent`**: Data collection agent that monitors EPU output and communicates with backend
15+
916
- Project board: <https://github.com/orgs/DiamondLightSource/projects/33/views/1>
1017
- Test Datasets: https://gitlab.diamond.ac.uk/scisoft/cryoem/smartem-decisions-test-datasets
1118

@@ -18,7 +25,7 @@ Releases | <https://github.com/DiamondLightSource/smartem-decisions/relea
1825
## Quick Start
1926

2027
```python
21-
from src._version import __version__
28+
from smartem_backend._version import __version__
2229

2330
print(f"Hello smartem_backend {__version__}")
2431
```
@@ -81,7 +88,7 @@ print(f"Hello smartem_backend {__version__}")
8188
# venv and requirements
8289
python -m venv .venv
8390
source .venv/bin/activate
84-
pip install -e .[all] # .[dev,common,backend,agent]
91+
pip install -e .[dev] # or .[backend] for production
8592

8693
# Start services with verbosity controls:
8794
python -m smartem_backend.run_api -v # HTTP API with INFO logging

0 commit comments

Comments
 (0)