Skip to content

Releases: PhonologicalCorpusTools/SLPAA

v.0.2.1

29 Sep 23:48
dd9c69b

Choose a tag to compare

🚀 Version 0.2.1

We are excited to release a new version of Sign Language Phonetic-Annotator/Analyzer (SLP-AA)!

v.0.2.1 is intended to be a relatively stable release of most of the ‘basic’ functionality for the ‘annotation’ side of the software. While we are still tweaking some baseline elements, most of the annotation tools are present, and some analysis tools are available in beta.

DATA LOSS WARNING: v.0.2.0 (the previous version) introduced part of speech tags in sign-level information, which are only preserved when working with v.0.2.0 or later. Any PoS information will be lost without warning if the corpus is edited in a version earlier than v.0.2.0. To avoid data loss, please always use the latest version.

🛠 Installation (download links at the bottom of this page)

macOS:

  1. Download SLPAA.0.2.1.dmg or SLPAA.0.2.1_Intel.dmg, depending on your Mac's architecture.
  • You can check this under " → About This Mac." If your Chip says...
Chip You should use
Apple M1, M2, etc. SLPAA.0.2.1.dmg
Intel Core i5/i7/etc. SLPAA.0.2.1_Intel.dmg
  1. Double-click the .dmg file and drag the SLPAA icon to Applications.
  2. Double-click the icon to start. If you receive a warning message, try ctrl-clicking, selecting "Open," and giving permission. Or, go to 'System Settings' > 'Privacy & Security' and give the "Open anyway" permission for SLP-AA to run.
  3. It is normal for the SLPAA icon to briefly disappear before launching. Please give it a moment to start.

Windows:

  1. Download SLPAA.0.2.1.exe.
  2. Double-click to launch the program. If you receive a security warning, it can be bypassed safely (and you should not see it again next time you run the software).
  3. It might take some time for SLPAA to launch. Please give it a moment to start.

Fallback (running from the source code):

If the executable does not work on your system, please try running the program from the source code.

  1. Install Python 3.10 if you don't already have it.
  2. Download the source code (.zip or .tar.gz).
  3. Extract the downloaded file
  4. Use Terminal (or command prompt for Windows) and navigate to the extracted directory.
  5. Run pip install -r requirements.txt to install dependencies. This may take some time.
  6. Use cd src/main/python (or cd src\main\python for Windows) to navigate to the directory where the entry (main.py) lives. Once there, run python main.py (or python main.py for Windows) to launch the program.
  7. Alternatively, you can freeze the code and create your own executable. To do this, run these two additional commands:
  • pip install -r requirements_freeze.txt and then
  • pyinstaller slpaa.spec
    If successful, you can find either SLPAA.app (for macOS) or SLPAA.exe (for Windows) in the dist directory.

🎓 Getting started

We recommend selecting "Load Sample" when the software first opens, and then following along with the documentation section called About the Sample Corpus to get a feel for how the software is structured and how signs are represented.

What's Changed

  • 408 allow json imports with fallback non-manual by @stannam in #454
  • display sign type abbreviations for hand, arm, leg in uppercase (eg 2L) instead of lowercase (eg 2l) by @kvesik in #474
  • Bold highlight subsidiary nonmanual tabs when needed by @stannam in #471
  • 477 bug predefined location image filenotfound by @kvesik in #478
  • Update "neutral" checkboxes in sample corpus by @gracemyz in #480
  • ensure that "Only Arm2/Leg2 moves" has correct articulator number associated by @kvesik in #482
  • 408 allow json imports by @kvesik in #473
  • 488 include forearm flag (field 1) in abbreviation for handconfiguration module by @kvesik in #489

Full Changelog: v0.2.0...v.0.2.1

v.0.2.0

28 Jul 23:56
9afe7ef

Choose a tag to compare

🚀 Version 0.2.0

We are excited to release a new version of Sign Language Phonetic-Annotator/Analyzer (SLP-AA)!

v.0.2.0 is intended to be a relatively stable release of most of the ‘basic’ functionality for the ‘annotation’ side of the software. While we are still tweaking some baseline elements, most of the annotation tools are present, and some analysis tools are available in beta.

IMPORTANT: This version introduces part of speech tags in sign-level information, which are only preserved when working with this version or later. Any PoS information will be lost without warning if the corpus is edited in an earlier version. To avoid data loss, please always use the latest version.

🛠 Installation (download links at the bottom of this page)

macOS:

  1. Download SLPAA.0.2.0.dmg or SLPAA.0.2.0_Intel.dmg, depending on your Mac's architecture.
  • You can check this under " → About This Mac." If your Chip says...
Chip You should use
Apple M1, M2, etc. SLPAA.0.2.0.dmg
Intel Core i5/i7/etc. SLPAA.0.2.0_Intel.dmg
  1. Double-click the .dmg file and drag the SLPAA icon to Applications.
  2. Double-click the icon to start. If you receive a warning message, try ctrl-clicking, selecting "Open," and giving permission. Or, go to 'System Settings' > 'Privacy & Security' and give the "Open anyway" permission for SLP-AA to run.
  3. It is normal for the SLPAA icon to briefly disappear before launching. Please give it a moment to start.

Windows:

  1. Download SLPAA.0.2.0.exe.
  2. Double-click to launch the program. If you receive a security warning, it can be bypassed safely (and you should not see it again next time you run the software).
  3. It might take some time for SLPAA to launch. Please give it a moment to start.

Fallback (running from the source code):

If the executable does not work on your system, please try running the program from the source code.

  1. Install Python 3.10 if you don't already have it.
  2. Download the source code (.zip or .tar.gz).
  3. Extract the downloaded file
  4. Use Terminal (or command prompt for Windows) and navigate to the extracted directory.
  5. Run pip install -r requirements.txt to install dependencies. This may take some time.
  6. Use cd src/main/python (or cd src\main\python for Windows) to navigate to the directory where the entry (main.py) lives. Once there, run python main.py (or python main.py for Windows) to launch the program.
  7. Alternatively, you can freeze the code and create your own executable. To do this, run these two additional commands:
  • pip install -r requirements_freeze.txt and then
  • pyinstaller slpaa.spec
    If successful, you can find either SLPAA.app (for macOS) or SLPAA.exe (for Windows) in the dist directory.

🎓 Getting started

We recommend selecting "Load Sample" when the software first opens, and then following along with the documentation section called About the Sample Corpus to get a feel for how the software is structured and how signs are represented.

What's Changed

  • 420 make location details tables searchable by @gracemyz in #423
  • 421 update the values columns of mvmt locn and reln search targets by @gracemyz in #425
  • Updated slot style to make the default text colour black by @YuHsiangLo in #424
  • Enable delete and rename targets by @gracemyz in #428
  • Handle Relation displaystr when missing articulators by @gracemyz in #432
  • 426 make details tables searchable in relation modules and associated relation modules by @gracemyz in #438
  • user can delete signs or modules via either ctrl/cmd+delete, or ctrl/cmd+backspace by @kvesik in #435
  • make location type buttons deselectable by @kvesik in #437
  • 443 move include flags from Signtypespecificationpanel button properties and Signtype.speclist to just Signtype.getabbreviation() function by @kvesik in #444
  • remove "closed A index" handshape from bent-A cell by @kvesik in #445
  • Search multiple module bug by @gracemyz in #447
  • Added Arms and Legs Tab to Sign Type Specification View by @partobm in #389
  • 433 add save feature for search results by @gracemyz in #439
  • 446 negative searches for sign type by @gracemyz in #449
  • 451 negative searches for orientation by @gracemyz in #453
  • Handle unspecified signtype by @gracemyz in #459
  • 455 negative searches for x slots hand config and sign info modules by @gracemyz in #463
  • 456 add part of speech tags to sign level information by @gracemyz in #461
  • add scrollbar to SLI by @gracemyz in #467
  • 465 selection access in x slot search by @gracemyz in #468

Full Changelog: v0.1.0...v0.2.0

v.0.1.0

26 Mar 19:49
c593873

Choose a tag to compare

🚀 Version 0.1.0 – Initial Release

We are excited to announce the first release of Sign Language Phonetic-Annotator/Analyzer (SLP-AA)!

v.0.1.0 is intended to be a relatively stable release of most of the ‘basic’ functionality for the ‘annotation’ side of the software. While we are still tweaking some baseline elements, most of the annotation tools are present, and some analysis tools are available in beta.

🛠 Installation (download links at the bottom of this page)

macOS:

  1. Download SLPAA.0.1.0.dmg or SLPAA.0.1.0_Intel.dmg, depending on your Mac's architecture.
  • You can check this under " → About This Mac." If your Chip says...
Chip You should use
Apple M1, M2, etc. SLPAA.0.1.0.dmg
Intel Core i5/i7/etc. SLPAA.0.1.0_Intel.dmg
  1. Double-click the .dmg file and drag the SLPAA icon to Applications.
  2. Double-click the icon to start. If you receive a warning message, try ctrl-clicking, selecting "Open," and giving permission. Or, go to 'System Settings' > 'Privacy & Security' and give the "Open anyway" permission for SLP-AA to run.
  3. It is normal for the SLPAA icon to briefly disappear before launching. Please give it a moment to start.

Windows:

  1. Download SLPAA.0.1.0.exe.
  2. Double-click to launch the program. If you receive a security warning, it can be bypassed safely (and you should not see it again next time you run the software).
  3. It might take some time for SLPAA to launch. Please give it a moment to start.

Fallback (running from the source code):

If the executable does not work on your system, please try running the program from the source code.

  1. Install Python 3.10 if you don't already have it.
  2. Download the source code (.zip or .tar.gz).
  3. Extract the downloaded file
  4. Use Terminal (or command prompt for Windows) and navigate to the extracted directory.
  5. Run pip install -r requirements.txt to install dependencies. This may take some time.
  6. Use cd src/main/python (or cd src\main\python for Windows) to navigate to the directory where the entry (main.py) lives. Once there, run python main.py (or python main.py for Windows) to launch the program.
  7. Alternatively, you can freeze the code and create your own executable. To do this, run these two additional commands:
  • pip install -r requirements_freeze.txt and then
  • pyinstaller slpaa.spec
    If successful, you can find either SLPAA.app (for macOS) or SLPAA.exe (for Windows) in the dist directory.

🎓 Getting started

We recommend selecting "Load Sample" when the software first opens, and then following along with the documentation section called About the Sample Corpus to get a feel for how the software is structured and how signs are represented.

🖥️ Functionality

The following functions are fully in place unless specified otherwise and should be stable and work consistently.

Create a ‘corpus’ (=a list of individual signs)

  • filtering the corpus view
  • sorting the corpus view by entry ID, gloss, lemma, ID gloss, or dates
  • viewing one gloss per row vs. viewing one sign per row
  • access to copy / paste / edit / delete entries by right-clicking

Saving and re-loading a corpus

Sign-level information

  • multiple glosses per sign
  • one lemma and ID-gloss per sign
  • meta information about source, signer, frequency, coder, fingerspelling, compound, hand dominance, notes
    • NB: meta information is currently on a by-sign / by-corpus basis; future functionality will include allowing a repository of meta-information to pull from
  • automatic tracking of creation and modification dates

Modular functionality

  • signs can have unlimited movement, location, relation, orientation, hand configuration, and non-manual modules

Notes

  • available for all modules, allowing tagging of iconicity, completeness, variation, exceptionality, and other notes
  • often also available as individual options on selections through right-clicking
  • NB: these notes are not write-access functional on older Mac operating systems; we know they are not functional in 11.3, but are by 14.5

Display

  • ability to move and re-size default display windows and reload the same configuration on re-opening the software

Summary display

  • displays all specified modules with their timing relations
  • automatic generation of module numbers
  • automatic generation of ‘tool tips’ to summarize module contents
    • NB: tool tips not yet functional for non-manual modules
  • ‘associated’ modules jointly highlighted for reference
  • dynamic access to edit any module by double-clicking
  • access to copy / paste / delete elements by right-clicking

Timing relations

  • signs can have no timing specified or manual timing relations specified
    • NB: automatic timing relations based on movement specifications are planned but not yet implemented
  • both integer and partial x-slots can be specified
  • all modules are linked to timing specification for a given sign
  • both interval and ‘point’ timing can be selected for any module

Sign type information

  • ability to specify 1H / 2H sign
  • ability to specify information about relation between the hands in a 2H sign (symmetry, etc.)

Movement modules

  • ability to specify module as applying to one or both hands, one or both arms, or one or both legs
  • ability to specify module as ‘connected’ / in phase / out of phase movements for 2H signs
  • ability to specify a module as phonetic or phonological
  • both menu-based and typing-based access to specification
  • ability to specify movement type (perceptual shape (= “path” movement), joint-specific movement (= “local” movement), or handshape change)
    • for shapes, ability to specify absolute or relative directions of movement
  • ability to specify joint activity in addition to the general movement type
  • ability to specify additional movement characteristics like repetition, directionality, size, speed, force, tension
  • visualization of selected characteristics in menu form

Location modules

  • ability to specify module as applying to one or both hands, one or both arms, or one or both legs
  • ability to specify ‘connected’ signs for 2H signs
  • ability to specify a module as phonetic or phonological
  • ability to specify body-based or purely spatial locations
  • ability to specify locations through menu selection or typing, or, for body locations, selection on a diagram of the body
  • ability to auto-specify ‘neutral’ locations, linked to pre-specified sign type
  • ability to mark any location as ‘neutral’ manually
  • ability to select finer-grained surfaces, sub-areas, or joints, depending on the overall selected choice
  • NB: there are a few body-location images that are not yet included; see #337

(absolute) Orientation modules

  • ability to specify module as applying to one or both hands
  • ability to specify a module as phonetic or phonological
  • ability to specify the absolute direction of the palm
  • ability to specify the absolute direction of the finger roots

Hand configuration modules

  • ability to specify module as applying to one or both hands
  • ability to specify a module as phonetic or phonological
  • full ability to specify a Johnson & Liddell-style phonetic transcription, with visual aids to assist in knowing what the choices of transcription elements are
  • 142 pre-defined handshapes that can be selected with a full accompanying transcription
  • ability to modify the details of a pre-defined handshape once it has been selected

Non-manual modules

  • ability to specify a module as phonetic or phonological
  • ability to specify shoulder, body, head, eye gaze, facial expression (including eyebrows, eyelids, nose), mouth (including teeth, jaw, opening, lips, tongue, and cheek), and ‘air’ characteristics
    • ability to specify anatomical characteristics or larger-level ‘mouthing’ or ‘expression’ gestures
  • for each specification, ability to choose static/dynamic, select the specific action/state, and specify repetition, directionality, and additional characteristics

Relation modules

  • ability to specify a module as phonetic or phonological
  • ability to specify the two elements that are in a relation, including hands, arms, legs, and existing locations and movements
  • ability to specify hand / arm / leg parts involved in the relation
  • ability to specify contact and contact type / manner
  • ability to specify the direction of the relation between the two elements
  • ability to specify the distance between the two elements in relation to each other

Editing, copying, deleting entries

  • whole signs, individual modules, and the timing structure of a module can all be copied and pasted, into the same or a new corpus

Show version number

Setting preferences

  • display
    • number of displayed decimals
    • default coder name
    • display of tooltips
    • default font size
  • entry ID
    • auto-assignment of unique sequential numbers of signs in a corpus
    • ability to specify information displayed in entry ID
      ...
Read more