added readme

This commit is contained in:
2022-02-22 20:36:17 +01:00
parent f140256e37
commit 2cbeae72bd

23
procprof/README.md Normal file
View File

@ -0,0 +1,23 @@
# Processing Profiler
## Preparation
Extract some camera images and dump them:
```bash
./make_example_images.py -i /some/measured_data.CAMERAS.h5 -c SOME-CAMERA
```
## Profiling
Profile a processing script using the example images:
```bash
./procprof.py a_processing_script.py example_images.npy
```
Profiling output files are written to `./prof/`.
Check `-h` on both scripts for more options.