home *** CD-ROM | disk | FTP | other *** search
/ Current Shareware 1994 January / SHAR194.ISO / astronom / saguaro2.zip / SACREP.TXT < prev   
Text File  |  1993-05-24  |  14KB  |  234 lines
  1.  
  2.          SACREP Version 6.0  -  The Quick Overview 
  3.                    by A.J. Crayon and Dan Ward 
  4.                           May 24, 1993
  5.  
  6.  SACREP.EXE  is  a  report  generator program that can  be  used  against  the 
  7.  SAC60.DBF  file.   This  program  is designed as  a  quick  way  to  generate 
  8.  observing lists from the SAC60 database for those who are not conversant with 
  9.  database programs.  It can also be used to extract smaller files for use with 
  10.  database managers, word processing programs, text editors or even spreadsheet 
  11.  programs.   Version 6.0 replaces all earlier versions. 
  12.  
  13.  Nine  files are included within SACREP.ZIP.  This file, SACREP.TXT,  provides 
  14.  some background and simple instructions.  The files SAC1REP.FRM, SAC2REP.FRM,  
  15.  SAC3REP.FRM, SAC4REP.FRM and SAC5REP.FRM are report format files.  SACBLK.DBF 
  16.  is an empty datafile to provide the correct format for converting SAC60  text 
  17.  files  into  the  DBF format needed by SACREP.  The SACPARMS.DBF  file  is  a 
  18.  parameter  file telling the program where to find the data files.   The  main 
  19.  program is SACREP.EXE. 
  20.  
  21.  SAC  6.0  is  distributed with files in a ZIPed status.   If  you  used  the 
  22.  INSTALL.BAT program, it unZips the SAC60B through SAC60E into 24 separate 
  23.  ASCII files named SAC60-00.ASC through SAC60-23.ASC, which correspond to 
  24.  hours of right ascension.
  25.  
  26.                 The Main Menu
  27.  
  28.  Execute  the program by entering SACREP.  This will bring up the  main  menu, 
  29.  which  has  nine  menu options. The first option produces  reports  based  on 
  30.  Constellations.    The  second option generates reports based on a  range  of 
  31.  coordinates.   Option three creates a database extract for  a  Constellation.  
  32.  Option  four  creates a database extract based on Coordinates.   Option  five 
  33.  will  append  previously extracted small data files into a larger  file.  The 
  34.  sixth  option  will  create or update the constellation index  file  for  the 
  35.  database.  Option Seven will display the database entry for a single  option.  
  36.  Option  Eight updates the program parameters.  Option Nine will  convert  the 
  37.  SAC60.TXT  file  to  the DBF file format needed for all  the  other  options.  
  38.  Option zero is an Exit.  
  39.  
  40.  If  you  have never used SACREP before, the first time you  use  SACREP,  the 
  41.  SAC60 data files need to be converted to a DBF file.  This is  Option 9
  42.  9 from the main menu of SACREP.  Once you have converted the data, you could 
  43.  delete the SAC60-??.ASC files, but you probably want to maintain your 
  44.  original set of ZIP files in case you need them in the future.
  45.  
  46.  The  program  is shipped with SAC60.DBF as the database default  and  assumes 
  47.  that  the files are in a subdirectory called C:\SAC60.  If you  have  already 
  48.  installed an earlier version of SACREP, double check menu option 8 to see  if 
  49.  your  path and database filename are correct.  
  50.  
  51.                Producing Reports
  52.  
  53.  1.   To run an observing list based on a Constellation, the user is  prompted 
  54.  to enter the standard  three  letter  abbreviation   for   the   desired 
  55.  constellation.  (See the SACDOC.TXT FILE for a list of those abbreviations.)  
  56.  The program is not upper/lower case sensitive.
  57.  
  58.   Next,  enter a range of magnitudes for brightest  magnitude,  then  dimmest 
  59.  magnitude.  The  programs expect a range from -1 to 99.9  magnitude.   (Some 
  60.  objects  do  not have magnitudes - dark nebulae.  These are  listed  in  the 
  61.  database  with a value of 79.9.   All other  objects have a "normal" catalog 
  62.  magnitude rating.  A few objects with unknown magnitudes are listed 
  63.  with 99.9 for their magnitude.  
  64.  
  65.  Next,  indicate whether to route the report to a disk file (d) or  a  printer 
  66.  (p),  with  the printer as a default.  The disk file will be  an  ASCII  file 
  67.  complete with page headings, etc.  The next choice is to choose a  particular 
  68.  type of object for the observing list, such as GALXY for galaxies, DRKNB  for 
  69.  Dark   Nebula,  etc.   See  the  SAC60  note  file  for  the  full  list   of 
  70.  abbreviations.  The default option, ALL__ will provide a complete listing  of 
  71.  all object types that meet the other selection criteria.
  72.  
  73.  There  are 5 report formats to choose from.  Report type 1 has an 80 column 
  74.  format,  Format 2 is 128 columns; format 3 runs 160 columns, format  4 needs 
  75.  185 and format 5 runs 245 columns.  The first three contain only some of the 
  76.  database  fields,  while the last three options contain all of  the database 
  77.  fields.   Except for forms 1 and 5, the reports may fold the longest fields.  
  78.   
  79.  The program pauses for a printer check.  To keep it simple, I did not create 
  80.  a printer table, so you need to make sure that the printer is already set for 
  81.  the desired typefont.  If you send the report to a disk file, a filename must 
  82.  be entered.  If no file extension is provided, the program will automatically 
  83.  append  the  extension  of '.txt'.  The filename should not be one that is 
  84.  currently in use. 
  85.  
  86.   The last choice is to hit enter to process the report or enter 0 to  return 
  87.  to the main menu.  
  88.  
  89.   2.  Main Menu Option Two provides reports on a range of coordinates, object 
  90.  types  and magnitudes.  The program expects whole numbers between 0  and  24, 
  91.  for right ascension.  It expects whole numbers between -90 and 90  inclusive 
  92.  for declination.  The other choices follow the same format as described  for 
  93.  the Constellation report option.  Be sure to enter your desired  ranges,  as 
  94.  the default values will give you everything!
  95.  
  96.  3. & 4.   Database  extracts  allow you to  extract  all  of the  database 
  97.  information fields, based on the same type of selection criteria used by  the 
  98.  two report generator options.   If the database is used by someone who  never 
  99.  observes  objects  fainter  than 13th magnitude, and  never  lower  than  -40 
  100.  degrees  declination, those criteria could be used to create a  much  smaller 
  101.  version of the SAC60 database.  That database would then be much faster  than 
  102.  using  the full blown version.   The Database extracts for  Coordinates  uses 
  103.  the same selection criteria as the Coordinate report generators - except  the 
  104.  output goes to a file whose name you must supply. 
  105.  
  106.  The  text  file  version has all fields delimited  with  double  quotes  and 
  107.  separated by commas.  This type of file can be read by most database programs 
  108.  and  can  be imported into most spreadsheet software.  The DBF  extract  file 
  109.  version, is in a standard dBASE file format.  
  110.  
  111.   5.   Main Menu Option Five can be used to append files with the same  format 
  112.  into the other DBF files.  This is an easy way to create a variety of smaller 
  113.  observing   databases.   For  example,  the  user  could  create   individual 
  114.  constellation extracts, then append each file to have a new combined database 
  115.  such  as seasonal databases based on the available constellations.   We  have 
  116.  two warnings.  FIRST, the program will append one file to another.  So if you 
  117.  create  a database based on coordinates, then append a constellation  extract 
  118.  of  an  constellation  within  those same coordinates,  you  would  now  have 
  119.  duplicates  of some objects.  SECOND, if you plan to use the extracts to  run 
  120.  reports, be sure to run the INDEXING option, described below.
  121.  
  122.   6.   Option  Six  from the main menu will creates  index  files  to  provide 
  123.  reports  and  extracts  sorted  by Constellations, RA,  Object  name  or  the 
  124.  othernames  fields.   If you decide to use database extracts instead  of  the 
  125.  main database, you will need to index those new databases with this option.
  126.  
  127.   7.   Main Menu Option 7 will provide a listing of the data for a  particular 
  128.  object.  You can enter the Name or Other Name of an object.  For example, NGC 
  129.  1068  is also known as M 77. Be sure to use the name format as used in the 
  130.  SACDOC.TXT documentation file.  This program is looking for an exact match.
  131.  "BERK58" will not locate "Berk 58."  Upper/lower case does not matter, but 
  132.  spacing is critical.   
  133.  
  134.  The Messier Objects were loaded into the Other name field as five characters. 
  135.  M 101 is an 'M' followed by a blank space, then '101' M  33 is an 'M' followed 
  136.  by two blank spaces, then '33'  and M   1 is an 'M' followed by three blank 
  137.  spaces followed by '1'.  This maintains the ASCII sort order.
  138.  
  139.  You can continue  to  browse  forward in the database from any point by
  140.  entering an F, move backwards in the database by entering a B, or use Q  
  141.  to return to the main menu.   This browse  forward and backwards makes it 
  142.  easy to scan through a catalog.  For example, you can scan through the 
  143.  entire Messier catalog by searching on "M" or "M   1" and going Forward.
  144.  
  145.  8.   From the Main Menu, option 8 will allow you to  modify  the  program  
  146.  parameters.   Entering  an  8 takes you to a  screen  showing  your  current 
  147.  program settings.  The first choice displays your current drive:\path.  Enter 
  148.  the new drive:\path if needed; or hit enter to leave it alone.
  149.   
  150.  The  next line shows the current database filename.  Enter a  new name,   if  
  151.  needed, or hit enter to leave it as it is.  The  last  line prompts  you  for 
  152.  the  display  options.   There  are  two color   and  one  black  and  white 
  153.  alternative.   As  this  program only displays text,  there  are  no  special 
  154.  graphics considerations.
  155.  
  156.  9.   Option 9 is used to convert the distribution database text files to the 
  157.  DBF  format.  If you are using a hard disk, INSTALL.BAT will  have  extracted 
  158.  the four text files into 24 data files, SAC60-00 through SAC60-23.  Option 9 
  159.  checks your parameters, converts the ASCII files to SAC60.DBF and then 
  160.  indexes it.
  161.                     
  162.                     How Do I Stop It?
  163.  If  you happen to hit the wrong key and start a report you do not want,  you 
  164.  can cancel out an in-progress action by holding down the ALT key and hitting 
  165.  the  letter C.  Alt-C is the standard cancel processing command  for Clipper 
  166.  compiled  programs.  If you are cancelling a printer report, this would  not 
  167.  clear  anything you may have already sent into a printer buffer  or spooler.  
  168.  Obviously,  you  can  also power down your computer to stop  a  process,  
  169.  but Alt-C is cleaner.
  170.  
  171.                For More Report Options
  172.  
  173.  SACREP will NOT meet all conceivable needs.  There are many good database 
  174.  programs on the market.  Most will be able to use or convert the SAC60-?? 
  175.  files or the SAC60.DBF files to a format they can use. 
  176.  
  177.                IF You Just HAVE to Know More 
  178.  
  179.  The  SACREP  programs  were written in dBASE III  plus,  and  compiled  
  180.  using Clipper.  SACREP.EXE is hereby placed in the Public Domain and may 
  181.  be  freely distributed  as  is,  provided  no fees are charged.   However,  
  182.  it must be distributed with all files intact. 
  183.  
  184.  The  programmers assume NO responsibility or liability for the program's  
  185.  use or misuse.  It is offered solely as a goodwill gesture to help support  
  186.  those whose astronomical skills exceed their computer programming skills! 
  187.  
  188.  You can leave a message for Dan Ward on the AstroForum in CompuServe 
  189.  (id 72040,3357), where he usually checks in at least once a week. 
  190.  
  191.                    
  192.                    Database Trivia 
  193.  
  194.  We hereby express my sincere thanks to the entire Saguaro Astronomy Club 
  195.  Database Project team, who gave us advance extracts of SAC60 to help  
  196.  develop this  program.   Their  dedicated efforts have provided astronomers  
  197.  with a fantastic  observing  database!  Our limited efforts to prepare 
  198.  this  report generator  program  and install program are a mere 
  199.  drop in the  bucket,  when compared with their work! 
  200.  
  201.  Nearly all of the original SAC Deep Sky database team members belong to the 
  202.  Saguaro Astronomy Club (SAC) in the Metro Phoenix area of Arizona, hence the 
  203.  name  of the  database.   (A  Saguaro is the large variety of  cactus  often  
  204.  seen  in Western movies and quite common around Phoenix.   Saguaros are 
  205.  massive plants with large upturned arms, and are only found in Arizona 
  206.  and Mexico.) 
  207.  
  208.  A.J. Crayon wrote SPROGS, a series of dBASE programs for the original release 
  209.  of SAC 4.0.  Dan Ward wrote SACREP 4.0. which was also released with SAC 4.0.  
  210.  We  combined  forces to create SACREP 5.0, which was a blend of the  best  of 
  211.  both.   We fixed a minor upper/lower case problem with SACREP  5.1.   
  212.  
  213.  SACREP  5.2a fixed a minor glitch by updating a filename in the new  version.  
  214.  SACREP 5.2b  was used as a test version by Dan Ward to figure out why some 
  215.  of the things that worked so well in dBASE did not translate into  his  
  216.  Clipper version.   Version 5.2c was a rewrite of version 5.2 and added 
  217.  faster report generation, the addition of a separate parameters screen, more 
  218.  formats for the printout reports, and improved individual object searches.  
  219.  
  220.  Version 6.0 is an update for the revision of the SAC deepsky database.  It 
  221.  also converts the Othernames and Object indexes to upper case so option 7 
  222.  is no longer case sensitive.  Due to changes in some field sizes, the 
  223.  elimination of one field and the addition of a new field, SACREP 6.0 
  224.  is not compatible with earlier versions of the database. 
  225.  
  226.  dBASE and dBASE III+ were registered trademarks of ASHTON-TATE.  CLIPPER is  
  227.  a registered  trademark  of Nantucket Corporation.  We hereby  recognize  
  228.  their ownership  to  said  terms throughout this document,  and  also  
  229.  respectfully kowtow in their directions for making our lives easier via 
  230.  the introduction of those stated products!  
  231.  
  232.      A.J. Crayon and Dan Ward   - May 24, 1993 
  233.  
  234.