Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
Comment: | Usage documentation |
---|---|
Downloads: | Tarball | ZIP archive | SQL archive |
Timelines: | family | ancestors | descendants | both | trunk |
Files: | files | file ages | folders |
SHA3-256: |
23934f44e65ea73c51a7e790b32596e8 |
User & Date: | jmcclure 2017-09-13 00:51:44 |
Context
2017-09-28
| ||
12:45 | Typos & grammar fixes in info.html; allow WM to chose size in mainwin.py check-in: b95740c293 user: jmcclure tags: trunk | |
2017-09-13
| ||
00:51 | Usage documentation check-in: 23934f44e6 user: jmcclure tags: trunk | |
2017-09-11
| ||
21:52 | Added OSs to TOC check-in: d33935bbfe user: jmcclure tags: trunk | |
Changes
Changes to info.html.
︙ | ︙ | |||
183 184 185 186 187 188 189 | href="https://en.wikipedia.org/wiki/YAML">Wikipedia</a> has a good introduction to YAML.</li> </ol> </section> <section id="usage"> <h2>Step-By-Step Usage</h2> | > > > > > > > > > > > | > > > > > > > > > > > > > > | > > > | 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 | href="https://en.wikipedia.org/wiki/YAML">Wikipedia</a> has a good introduction to YAML.</li> </ol> </section> <section id="usage"> <h2>Step-By-Step Usage</h2> <h3 id="usage-fex">Frequency Excursion</h3> <p>Version 1.0.0 has a minimal set of features for taking measures of frequency excursion. Below is an example sequence for analyzing a single song or set of songs. Future versions of TweetyPy will allow for numerous modifications to this workflow including dynamically raising or lowering the threshold for inclusion in the calculation, changing the shape and/or orientation of the eraser tool, moving back through the sequence of songs to repeat measures, cropping of songs, and entering notes to be saved with each song's data.</p> <ol> <li>Start TweetyPy. Currently a list of wave files can be passed on the command line. Dropping files on any desktop icon shoul also work but has not yet been tested.</li> <li>Add songs via the <code>File -> Add Songs</code> menu or the <code>Add Songs</code> toolbar button. Future versions will also allow dropping files into the main window.</li> <li>Move and resize the spectrogram for a song by dragging with the left an right mouse buttons.</li> <li>Select <code>Tools -> Eraser</code> or the <code>Eraser</code> toolbar button to enter erasing mode to remove unwanted points from the highlighted frequency excursion path.</li> <li>In eraser mode, erase by clicking and dragging in the spectrogram window. If you erase too much, there is an undo option (only one level of undo is available).</li> <li>When the signal has been appropriately cleaned up, select the <code>Songs -> Next Song</code> menu or <code>Next Song</code> toolbar button. Future versions will allow navigating back to previous songs to repeat or revise scores.</li> <li>After the last song has been scored, a save-file dialog will be presented. Select a location for the output data file.</li> </ol> </section> <section id="config2"> <h2>Advanced Configuration</h2> <p>Coming soon to upcoming releases.</p> </section> |
︙ | ︙ | |||
208 209 210 211 212 213 214 | excursion use will continue to be added through version 1.3 at which point frequency excursion should be feature-complete. Any remaining version 1.X releases will be for bug fixes or for code-refactoring in preparation of the additional features to come with the 2.X releases.</p> <h3>Version 1.0 release (Ain't She Tweet)</h3> <ol type="i"> | | > | 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 | excursion use will continue to be added through version 1.3 at which point frequency excursion should be feature-complete. Any remaining version 1.X releases will be for bug fixes or for code-refactoring in preparation of the additional features to come with the 2.X releases.</p> <h3>Version 1.0 release (Ain't She Tweet)</h3> <ol type="i"> <li>complete documentation (configuration)</li> </ol> <h3>Version 1.1 release (All a Bir-r-r-rd)</h3> <ol type="i"> <li>fix ugly toolbar icons on mac</li> <li>app icon</li> <li>adjustable eraser size</li> <li>toolbar position configuration</li> <li>add save button and remember filename (use as default for next save)</li> </ol> <h3>Version 1.2 release (Bad Ol' Putty Tat)</h3> <ol type="i"> |
︙ | ︙ |