Package: birdears
birdearsLicensed withGNU AGPLv3IntroductionbirdearsWhat is musical ear trainingFeaturesInstallingInstalling the dependenciesArch LinuxInstalling birdearsIn-depth installationAlternative installation: Cloning this RepositoryRunningKeybindingsDocumentationContributingSupport ChannelsChannelSiteDescriptionChat (Matrix)#birdears:mozilla.orgchat channelGitHub Discussionsdiscussionsgeneral discussionGitHub Issuesissuesfor issues with the softwareDocumentationhttps://birdears.readthedocs.io/extended documentation atReadTheDocsPyPIhttps://pypi.python.org/pypi/birdearspython package/repositoryGitHubhttps://github.com/iacchus/birdearsmainline repositoryTUICLIIntroductionbirdearsbirdearsis a software written in Python 3 for ear training for musicians
(musical intelligence, transcribing music, composing). It is a clone of the
method used byFuncitional Ear Trainerapp for Android.It has five different kinds of musical exercises, which are:melodic interval,harmonic interval,melodic dictation,instrumental,
andnote name.In resume, with themelodic intervalmode two notes are played one after the
other and you have to guess the interval; with theharmonic intervalmode,
two notes are played simoutaneously (harmonically) and you should guess the
interval.With themelodic dictationmode, more than 2 notes are played (ie., a
melodic dictation) and you should tell what are the all intervals composing the
melody played.Theinstrumentalmode works in a fashion similar to the melodic dictation
mode, but you will be expected to play the notes on your instrument,ie.,
birdears will not wait for a typed reply and you should prectice with your own
judgement. The melody can be repeated as much times as necessary so you can
the time you need to try out.Thenotenameis made for you to learn the note names inside a scale by its
melodic interval from the tonic. For example, in a tonic of 'C',
when aP5interval is played, you are expected to reply with theC's 5th,
this is,G.What is musical ear trainingthis needs to be written. The method.It is currentlybeing written hereFeaturesDifferent kind of exercises for ear training.Pretty much configurable: you can create more difficult exercises as you progress.Exercises from configuration files: you can make presets and share themCan be used interactively from a Python console.(docs needed)Can be used as a Python library.(docs needed)Installing1. Installing the dependenciesbirdearsdepends onpython >= 3.7andsox; the latter should be installed
by your distribution's package manager (supposing you're using GNU/Linux) and
provides theplaycommand.)(Please send the steps for your OS)Arch Linuxsudopacman-Syusoxpythonpython-pipDebian/Ubuntusudoaptinstallsoxpython3python3-pippython3-venv2. Installing birdearsAfter installing the above stated dependencies for your operating system, you
can install the software with the following command:pip3install--user--upgrade--no-cache-dirbirdearsThen add the installation directory to your PATH via your.bashrc,.zshrc,
or the respective file for your shell:exportPATH="$(python3-msite--user-base)/bin:${PATH}"This path is where the command will be installed when using--usermethod.If you prefer, you can skip step 2 and start the software with:python-mbirdears--help3. RunningAfter installing just run:birdears--helporpython3-mbirdears--helpWhat is 'pip'?The softwarepipis the python package installer. The arguments used are
the following:argmeaningpip3 installinstall command--userinstalls on the user home; no need to root access/ global install--upgradeif it is already installed, upgrade nonetheless if there is an upgrade available--no-cache-diravoid previously downloaded versions; always check PyPI server for newer versionsbirdearsthe software to be installedpipwill then download and install the software from the Python's official
repository, thepackage in here.Addendum: In-depth installation using a virtualenvYou can choose to use a virtualenv to use birdears; this should give you an
idea on how to setup one virtualenv.You should first install virtualenv (for python3) using your distribution's
package (supposing you're on linux), then on terminal:usepythonorpython3depending on your operating system distribution.python-mvenv~/.venv# create the virtualenv in the  ~/.venv/ directorysource~/.venv/bin/activate# activate the virtualenv; this should be done# every time you may want to run the software# installed here. You can also put this line in# your .bashrc or .zshrc etc, so to start with# the shell.pipinstallbirdears# this will install the softwarebirdears--help# and this will run itUpgrading birdearsThe same command that installs upgrades it:pip3install--user--upgrade--no-cache-dirbirdearsKeybindingsThe following keyboard diagrams should give you an idea on how the keybindings work. Please
note how the keys on the line fromz(unison) to,(comma,octave) represent the notes
that arenaturalto the mode, and the line above represent the chromatics.Also, for exercises with two octaves, theuppercased keys represent the second octave. For
example,zisunison,,is theoctave,Z(uppercased) is thedouble octave. The same
for all the other intervals.Ionian (Major)These are the keybindings for theIonian (Major) Scale; black keys are the chromatic notes.DorianPhrygianLydianMixolydianAeolian (minor)LocrianAdvancedthis is still being improvedLegend for the keys on the diagram above:Text  FormatScale DirectionOctaveblue (bold italic)descendingsecond octave (shift or caps lock)pink (bold)descendingfirst octaveblack/white (bold)ascendingfirst octaveblack (italic)ascendingsecond octave (shift or caps lock)White keysare the diatonic notes,black keysare the chromatic ones.Descendent mode are usable for exercises with-dor--descendent.Chromatic keys are usable for exercises with-cor--chromatic.Second octave is usable for exercises with-n 2or--n_octaves 2DocumentationFull documentation for this software is available at birdearsRead The Docsand also inPDF format.ContributorsMade withcontrib.rocks.ContributingThose who want to contribute to this project can readCONTRIBUTING.md.