hum-parser is a repository of data definitions and functions for parsing humdrum files. Data definitions and functions are written in the Racket language.
hum-parser is able to parse a humdrum file into records and spines, allowing the user to write these data into new files for use with other programs, or for use directly (i.e. without writing) with other parts of the hum-parser.
The ultimate goal of hum-parser is to map spines on to tree structures. Such structures would enable the user to write new functions that traverse humdrum data without having to worry about parsing records or spines.
Racket is a LISP-dialect. Read more on the language here. Consult the documentation here.
To install Racket, follow the Getting Started page of the documentation.
There are two primary ways of using Racket. One is through DrRacket, the language's
IDE. An executable for the IDE will be installed when following the Getting Started
page above. The second and preferred way for hum-parser is on the command-line
by running the racket command. After installing Racket, it is recommended that the
user add the path to the bin directory to their ~/.bshenv or ~/.zshenv file to make it
easier to run racket from anywhere.
hum-parser may eventually be translated into Racket's sister language Typed Racket
to allow for type-checking of user-defined types such as HumdrumFile and GlobalSpine.