-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.qmd
64 lines (53 loc) · 2.33 KB
/
README.qmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
---
title: Getting started with `fave-recode`
engine: jupyter
format: gfm
---
[](https://codecov.io/gh/Forced-Alignment-and-Vowel-Extraction/fave-recode)
[](https://codeclimate.com/github/Forced-Alignment-and-Vowel-Extraction/fave-recode/maintainability)
[](https://github.com/Forced-Alignment-and-Vowel-Extraction/fave-recode/actions/workflows/test-and-run.yml)
[](https://forced-alignment-and-vowel-extraction.github.io/fave-recode/)
[](https://zenodo.org/badge/latestdoi/605740158)
The idea behind `fave-recode` is that no matter how much you may adjust the dictionary of a forced-aligner, you may still want to make programmatic changes to the output.
## Installation
You can install `fave-recode` at your system's command line with `pip`.
```bash
pip install fave-recode
```
```{python}
#| eval: false
#| echo: false
!pip install fave-recode
```
## Basic usage
Installation of the `fave-recode` python package makes the `fave_recode` executable, which can also be run at the command line. You can get help with `--help`
```bash
fave_recode --help
```
```{python}
#| filename: terminal
#| echo: false
!fave_recode --help
```
To recode a single file, you need to provide `fave_recode` with, minimally, the input file (the `-i` flag), and the recoding scheme (with the `-s` flag). There are a few default recoding schemes that come with `fave_recode`.
```bash
ls data
```
```{python}
#| echo: false
!ls docs/getting-started/data/
```
```bash
fave_recode -i data/josef-fruehwald_speaker.TextGrid -s cmu2phila -a cmu_parser
ls data
```
```{python}
#| echo: false
!fave_recode -i docs/getting-started/data/josef-fruehwald_speaker.TextGrid -s cmu2phila -a cmu_parser
!ls docs/getting-started/data
```
```{python}
#| echo: false
!rm docs/getting-started/data/josef-fruehwald_speaker_recoded.TextGrid
```