[Phpgroupware-cvs] old/brewer/doc/BrewNIX.doc, 1.1

[nomail]

Update of /old/brewer/doc
Added Files:
        Branch: 
          BrewNIX.doc

date: 2004/12/30 07:50:59;  author: skwashd;  state: Exp;

Log Message:
keep a historic record of the app
=====================================================================
*****************************************************************
*                                                               *
*                    BrewNIX Documentation File                 *
*                                                               *
*****************************************************************


+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+       Date: 26 Mar 96              Current Version: 1.0       +
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++


BrewNIX is a recipe formulator which is intended for use by home
brewers.  BrewNIX allows the user to choose the style of beer that
they desire to emulate (according to the 1995 AHA Style Guidelines),
as well as selecting yeasts, malts (grains and adjuncts) and hops from
rather extensive data bases.  The user is also allowed to specify the
name of the recipe, the boil and total volumes for the recipe, along
with the apparent attenuation of the yeast and the extraction
efficiency of the mashing procedure for any of the unconverted
grains/adjuncts in the malt data base.  The user can also choose from
three distinct methods of calculating hop bitterness, as well as
specifying if a hop bag is used.

The style, yeast, malt and hop data bases are stored in ASCII text
files, which allows for easy modification, addition or deletion of
entries.

The entries in the style data base file "aha.dat" each consist of:
                (Sources: (a) The AHA WWW home page)

                (1) Style Name,
                (2) Minimum Original Gravity,
                (3) Maximum Original Gravity,
                (4) Minimum Alcohol by Volume (%),
                (5) Maximum Alcohol by Volume (%),
                (6) Minimum Color (L),
                (7) Maximum Color (L),
                (8) Minimum Bitterness (IBU),
                (9) Maximum Bitterness (IBU).

The entries in the yeast data base file "yeast.dat" each consist of:
                (Sources: (a) HopTech Brewing Supplies Catalog
                          (b) William's Brewing Supplies Catalog)

                (1) Yeast Name,
                (2) Average Apparent Attenuation (%),
                (3) Yeast Flocculation Rate Flag
                        (0 = Low, 1 = Average, 2 = High).

The entries in the malt data base file "malt.dat" each consist of:
                (Sources: (a) "The Home Brewer's Companion"
                              by Charlie Papazian
                          (b) "Brewing the World's Great Beers"
                              by Dave Miller)

                (1) Malt Name,
                (2) Original Gravity Contribution
                        (1 + points/pound/gallon),
                (3) Average Color (L),
                (4) Starch Conversion Flag
                        (0 = Unconverted, 1 = Converted).

The entries in the hop data base file "hop.dat" each consist of:
                (Sources: (a) "Using Hops"
                              by Mark Garetz
                          (b) "The New Complete Joy of Home Brewing"
                              by Charlie Papazian
                          (c) William's Brewing Supplies Catalog)

                (1) Hop Name,
                (2) Average Alpha Acid Content (%),
                (3) Average Total Iols Content (%).

Recipes are stored in binary form in the recipe data base file
"recipes.rdb".  This file is read when BrewNIX is started.  The file
is written at shutdown if changes have been made to recipes in the
data base (via Load Recipe/Edit Recipe/Save Recipe), or if recipes
have been added to (via New Recipe/Save Recipe) or deleted from (via
Delete Recipe) the data base.  The auxiliary program RDBInit is used
to generate an initial version of the recipe data base binary file.

The various methods available for calculating hop bitterness are those
due to Rager, Garetz and Tinseth, which are each briefly described in
"Norm Pyle's Hop FAQ" (address@hidden).  The method
that is used to calculate the IBU values of each of the hops in the
brew is listed on the hop title line.  The user may choose a different
method for calculating hop bitterness via the Options/IBU Method comm-
and sequence from either the New Recipe or Load Recipe screen.

BrewNIX is built on top of the Curses terminal I/O package.  NOTE:
The screen/window that BrewNIX uses is assumed to be 100 columns wide
by 40 lines long.  The various options at each of the command levels
are initiated by entering the single character of the command which is
in parentheses.  Either upper or lower case characters may be supp-
lied.  When an entry is presented to the user in reverse-video format, 
the program expects input from the user, either by entering data via
the keyboard or by scrolling through a list of options.  The user may
"scroll" through the various entries in the styles, malts and hops
data bases, as well as the units options, by pressing the SPACE or '^'
(shift-6) keys to scroll forward or backward through the list.  Once
the desired choice has been reached, simply press the ENTER/RETURN key
to accept it. Default values are supplied where applicable.  If the
user wishes to use the default value, simply press the ENTER/RETURN
key.

The original version of the code (Version 0.10) was written by
Nathaniel "Teddy" Winstead (address@hidden).  The Curses-based
routines for terminal I/O were written by George Sherouse.  The curr-
ent version has been extensively modified and enhanced by Richard
"Spike" Procassini (address@hidden).  Refer any questions or bug
reports regarding BrewNIX to address@hidden

BrewNIX is Copyright (C) 1995 by Richard J. Procassini, under the
terms and conditions of the GNU General Public License (see file
"COPYING" for the text of the GNU General Public License).  See file
"brewnix.h" for warranty and redistribution information.

Good Luck and Hoppy Brewing!

                                Dr. Richard "Spike" Procassini
                                address@hidden