Package: tealc
tealctealcis a command-lineTensionEstimate cALCulator for stringed
instruments. Users can calculate tensions for single strings or string sets.
Estimates are available for most common string materials for acoustic and
electric instruments. Tension estimates are based on published data from major
US string manufacturers.Tensions estimates should be regarded as just that:estimatesonly,
approximate tensions under ideal conditions. Variations in acutal string length
due to bridge compensation, environmental conditions, string age, and and
manufacturing tolerances all affect the actual tension of a string. Use
estimates fromtealcas a guide only.RequirementsThe principal requirement is a working Python 3 installation or virtual
environment.Officially,only Linux and Windows are supported. However,tealccan run on
other systems can run on other platforms such as the BSDs and macOS, provided:the user has write permissions to the platform's (or environment's) Python
install directory (generally Scripts/), andthe install directory is on the user'sPATH.Installationpython -m pip install -U tealcUsagetealccontains these subcommands:tealc string: Calucate tension estimate for a single string.tealc set: Calculate tension estimates for a string set.tealc file: Calculate string set tension estimates from a file.tealc materials: Print a chart of string material codes and descriptions.tealc help: Open the tealc manual.tealc stringUsage:tealc string [OPTIONS] GAUGE MATERIAL PITCH LENGTHREQUIREDGAUGEString gauge in inches, 1/1000in, or mm with the--siflag. Inch gauges may
  optionally be in thousandths of an inch:11or.011are both valid and
  produce the same output.MATERIALShort code for string construction material. Options:codematerialpsplain steelnpsnickel plated steel woundpbphosphor bronze wound802080/20 bronze wound851585/15 bronze woundssstainless steel roundwoundfwstainless steel flatwoundpnpure nickel woundPITCHTuned pitch of string in scientific pitch notation, from A0-E5.  Middle C is C4, and A440 is A4. Octaves change at C: A2, B2 is followed by C3, D3, ..., A3, B3, C4, ...Examples of open-string pitches in standard tunings:Guitar: E2, A2, D3, G3, B3, E4Bass: (B0), E1, A1, D2, G2Mandolin/violin: G3, D4, A4, E5Banjo: G4, D3, G3, B3, D4LENGTHScale length of the instrument in inches, 1/1000in, or mm with the--siflag.OPTIONAL--siSupply gauge and length arguments in millimenters.
  Tension is returned in kilograms (converted from pounds; used in place of Newtons.)EXAMPLEStealc string .011 ps E4 25.5tealc string --si 1.37 pb E2 632.5tealc setusage: `tealc set [OPTIONS]REQUIRED-l, --lengthScale length, just as in `tealc string`-s, --string <GAUGE MATERIAL PITCH>...Repeated option, per string for the entire set. Requiremnts for the sub-arguments in `<GAUGE MATERIAL PITCH>` are just as in "tealc string".OPTIONAL--siSupply set-wide --length and per-string GAUGE arguments in millimenters inctead of inches. Tension is returned in kilograms.--title TEXTAn optional title for the output chart.EXAMPLEStealc set -l 25.5 -s 10 ps e4 13 -s 13 ps b3 -s 17 ps g3 -s 26 nps d3 \
    -s 36 nps a3 46 -s 46 nps e2tealc set -l 34 -s 45 bfw g2 -s 60 bfw d2 -s 80 bfw a1 -s 105 bfw e1 \
    --title "Bass Flatwound Mediums"tealc fileusage:tealc file SETFILEREQUIRED:SETFILEA file formatted using the format:
  ```
  length = LENGTH
  GAUGE MATERIAL PITCH
  [GAUGE MATERIAL PITCH]
  [...]
  [si = True or False]
  ```An example SETFILE for a common set of light gauge ("10's") electric guitar strings on a Fender-scale instrument, with nickel plated steel wound strings, would look like this:length = 25.5
10 ps e4
13 ps b3
17 ps g3
26 nps d3
36 nps a2
46 nps e2The "length = ..." line and at least one "GAUGE MATERIAL PITCH" line are required."si = False" is not required, and the SetFileParser.si attribute defaults to False if no "si = ..." line is included.OPTIONAL:--siShow output chart units in mm/kg.--title TEXTAn optional title for the output chart.EXAMPLE:tealc file ~/path/to/setfiletealc materialsPrint a chart of material codes and their descriptions.tealc helpPrint a man page style help manual to the terminal (a formatted version of thisUsagesection).