spacr-tutorials / README.md
einarolafsson's picture
Add author, links and citation to the dataset card
b41aea7 verified
|
Raw
History Blame Contribute Delete
2.65 kB
---
license: mit
language:
- en
- es
- fr
- hi
- it
- pt
- ja
- zh
tags:
- spacr
- microscopy
- tutorial
- narration
- text-to-speech
pretty_name: spaCR tutorial narration and 4K lesson video
---
# spaCR tutorial media
Narration and 4K video for the [spaCR](https://github.com/EinarOlafsson/spacr)
interactive tutorial library, served directly to
<https://einarolafsson.github.io/spacr/tutorials/>.
spaCR is a toolkit for microscopy and single-cell analysis of pooled CRISPR
screens. This repository holds the media its 40-lesson tutorial player streams;
it is not a training dataset.
## Why it lives here
GitHub Pages caps a published site at 1 GB. The full narration set is 2,662 MiB
across 54 voices, so the site could only ever publish **one voice per language**
— 27 of the 28 English voices were unreachable. Hosting the audio here removes
the cap rather than rationing it, and leaves room for the 4K video too.
## Layout
Paths mirror the tutorial player's own, so a single base URL resolves both:
```
<lesson_id>/audio/<language>/<voice>.m4a narration
<lesson_id>/audio/<language>/<voice>.json word timings for captions and sync
<lesson_id>/video/<lesson_id>_silent.mp4 4K silent master (3840x2160)
```
For example:
```
07_mask/audio/en/af_heart.m4a
07_mask/audio/ja/jf_alpha.m4a
07_mask/video/07_mask_silent.mp4
```
## Contents
| | |
|---|---|
| Lessons | 40 |
| Narrated languages | 8 (en, es, fr, hi, it, pt-BR, ja, zh-CN) |
| Voices | 54 |
| Narration files | 2,160 (~2,662 MiB) |
| 4K silent masters | 40 (~681 MiB) |
## How the player uses it
The video carries **no audio track**. The player plays a silent master and
overlays whichever narration voice the visitor picks, mapping the two timelines
onto each other so any voice fits any lesson. The site offers 1440p by default
and the 4K cut from here as a quality option; both are the same cut on the same
timeline, so switching quality does not interrupt narration.
Narration was rendered with [Kokoro-82M](https://huggingface.co/hexgrad/Kokoro-82M).
## Author
Einar Birnir Ólafsson — [ORCID 0000-0002-3388-061X](https://orcid.org/0000-0002-3388-061X)
Uppsala University & University of Michigan–Ann Arbor
* spaCR source: <https://github.com/EinarOlafsson/spacr>
* Documentation: <https://einarolafsson.github.io/spacr/>
* Tutorials: <https://einarolafsson.github.io/spacr/tutorials/>
* Package: <https://pypi.org/project/spacr/>
## Citing
If spaCR contributes to your research, cite the software via its
[CITATION.cff](https://github.com/EinarOlafsson/spacr/blob/main/CITATION.cff).
## Licence
MIT, matching spaCR itself.