Merge branch 'master' into workflows

chrisbrickhouse · Oct 5, 2022 · dd34199 · dd34199
2 parents 46a7c9b + 3088b9e
commit dd34199
Show file tree

Hide file tree

Showing 95 changed files with 2,261 additions and 13,466 deletions.
diff --git a/.gitignore b/.gitignore
@@ -10,3 +10,4 @@ docs/_build
 *.swp
 *.orig
 env
+dist/*
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,32 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: 'FAVE: Forced alignment and vowel extraction'
+message: Please cite this software using these metadata.
+type: software
+authors:
+  - given-names: Ingrid
+    family-names: Rosenfelder
+  - given-names: Josef
+    family-names: Fruehwald
+    email: [email protected]
+    orcid: 'https://orcid.org/0000-0001-8480-9461'
+  - given-names: Keelan
+    family-names: Evanini
+  - given-names: Scott
+    family-names: Seyfarth
+  - given-names: Christian
+    family-names: Brickhouse
+    orcid: 'https://orcid.org/0000-0002-2748-8056'
+  - given-names: Kyle
+    family-names: Gorman
+    orcid: 'https://orcid.org/0000-0002-4233-6595'
+  - given-names: Hillary
+    family-names: Prichard
+  - given-names: Jiahong
+    family-names: Yuan
+repository-code: 'https://github.com/JoFrhwld/FAVE'
+license: GPL-3.0
+version: v2.0.1
+date-released: 2022-08-11
diff --git a/README.rst b/README.rst
@@ -0,0 +1,15 @@
+FAVE: Forced Alignment and Vowel Extraction
+===========================================
+
+Installation
+------------
+
+::
+    pip install fave
+
+Requirements
+------------
+
+``fave-align`` requires installation of HTK v3.4.1
+
+``fave-extract`` requires praat in your path
diff --git a/dist/fave-2.0.1-py3-none-any.whl b/dist/fave-2.0.1-py3-none-any.whl
diff --git a/dist/fave-2.0.1.tar.gz b/dist/fave-2.0.1.tar.gz
diff --git a/docs/_build/doctrees/code/align/aligner.doctree b/docs/_build/doctrees/code/align/aligner.doctree
diff --git a/docs/_build/doctrees/code/align/index.doctree b/docs/_build/doctrees/code/align/index.doctree
diff --git a/docs/_build/doctrees/code/align/transcriptprocessor.doctree b/docs/_build/doctrees/code/align/transcriptprocessor.doctree
diff --git a/docs/_build/doctrees/code/aligner.doctree b/docs/_build/doctrees/code/aligner.doctree
diff --git a/docs/_build/doctrees/code/cmudictionary.doctree b/docs/_build/doctrees/code/cmudictionary.doctree
diff --git a/docs/_build/doctrees/code/extract/esps.doctree b/docs/_build/doctrees/code/extract/esps.doctree
diff --git a/docs/_build/doctrees/code/extract/index.doctree b/docs/_build/doctrees/code/extract/index.doctree
diff --git a/docs/_build/doctrees/code/extract/mahalanobis.doctree b/docs/_build/doctrees/code/extract/mahalanobis.doctree
diff --git a/docs/_build/doctrees/code/extract/plotnik.doctree b/docs/_build/doctrees/code/extract/plotnik.doctree
diff --git a/docs/_build/doctrees/code/extract/remeasure.doctree b/docs/_build/doctrees/code/extract/remeasure.doctree
diff --git a/docs/_build/doctrees/code/extract/vowel.doctree b/docs/_build/doctrees/code/extract/vowel.doctree
diff --git a/docs/_build/doctrees/code/praat.doctree b/docs/_build/doctrees/code/praat.doctree
diff --git a/docs/_build/doctrees/code/transcriptprocessor.doctree b/docs/_build/doctrees/code/transcriptprocessor.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/usage/installation.doctree b/docs/_build/doctrees/usage/installation.doctree
diff --git a/docs/_build/doctrees/usage/quickstart.doctree b/docs/_build/doctrees/usage/quickstart.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 95450042ea89bddbb1481c62b8e92e75
+config: 8745e4e4f0df8712ab397deb6ddc5d88
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_sources/code/aligner.rst.txt b/docs/_build/html/_sources/code/aligner.rst.txt
diff --git a/docs/_build/html/_sources/code/transcriptprocessor.rst.txt b/docs/_build/html/_sources/code/transcriptprocessor.rst.txt
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
@@ -6,21 +6,21 @@
 Forced Alignment and Vowel Extraction (FAVE)
 ============================================
 
-Welcome to the FAVE documentation
+This website documents the FAVE software, version 2. 
 
+.. warning::
+   If you have used FAVE before, please read :doc:`usage/whats-new` to familiarize yourself with the differences between the current and legacy versions of FAVE. 
+
+Guides and documentation
+------------------------
 .. toctree::
    :maxdepth: 2
 
-   Installing FAVE <usage/installation>
-   Quickstart guide <usage/quickstart>
-   fave.align module <code/align/index>
-   fave.extract module <code/extract/index>
-   code/cmudictionary
-   code/praat
-
+   usage/index
+   code/index
 
-Indices and tables
-==================
+Indices
+-------
 
 * :ref:`genindex`
 * :ref:`modindex`

diff --git a/docs/_build/html/_sources/usage/installation.rst.txt b/docs/_build/html/_sources/usage/installation.rst.txt
@@ -1,4 +1,27 @@
-Installing FAVE 2.0
-===================
+Installing FAVE 2
+=================
 
-To be created
+Required software
+-----------------
+
+FAVE sometimes requires other software libraries in order to work. 
+ * FAVE-align requires `SoX <http://sox.sourceforge.net/>`_ and `HTK <https://htk.eng.cam.ac.uk/>`_.
+ * FAVE-extract requires `Praat <https://www.fon.hum.uva.nl/praat/>`_.
+
+You will need to manually install these if they are not already installed on your computer.
+
+.. warning::
+   Mac users: HTK might need slight modification before it works. See `this bug report <https://github.com/JoFrhwld/FAVE/issues/48>`_.
+
+Install with PIP
+----------------
+
+FAVE is available on the Python Package Index (PyPI) as ``fave``. You can install it using:
+
+.. code-block:: console
+
+   python3 -m pip install fave
+
+Other package managers
+^^^^^^^^^^^^^^^^^^^^^^
+Work is ongoing to publish FAVE as a debian package, but no other package system is supported at the moment. If you would like to package FAVE for your system, please feel free to :doc:`contribute <../contributing>`!
diff --git a/docs/_build/html/_sources/usage/quickstart.rst.txt b/docs/_build/html/_sources/usage/quickstart.rst.txt
@@ -1,4 +1,24 @@
 Quickstart guide to using FAVE 2.0
 ==================================
 
-To be created
+ #. Install FAVE and its dependencies according to :doc:`the directions <installation>`.
+ #. Download the ``FAAValign.py`` and ``extractFormants.py`` scripts.
+ #. Check your transcription for out-of-dictionary words
+
+    .. code-block:: console
+       :caption: Check for out-of-dictionary words
+
+       python3 FAAValign.py --check unknown_words.txt AudioFile.wav TranscriptionFile.txt OutputAlignment.TextGrid
+ #. Open ``unknown_words.txt`` and create a transcription for each word listed.
+ #. Align your audio and transcripts including your new transcriptions:
+
+    .. code-block:: console
+       :caption: Begin forced alignment
+
+       python3 FAAValign.py --import custom_dictionary.txt AudioFile.wav TranscriptionFile.txt OutputAlignment.TextGrid
+ #. Extract formant data using the default settings:
+
+    .. code-block:: console
+       :caption: Extract formant data
+
+       python3 extractFormants.py AudioFile.wav Alignment.TextGrid OutputFileName.tsv
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,3 +10,4 @@ docs/_build @@
     *.swp
     *.orig
     env
+    dist/*