Available ROSE Documentation

This page specifies what documentation is available in ROSE and where to find it. There are three forms of documentation for ROSE (two of which are available in both postscript and html):

• ROSE User Manual
  The ROSE User Manual presents how to get started with ROSE and documents features of the ROSE infrastructure. The ROSE User Manual is found in the ROSE/docs/Rose directory. The ROSE User Manual can also be found at (link to LaTeX document):
  ROSE UserManual (postscript version) or
  ROSE User Manual (html version) .
  
• ROSE Tutorial
  The ROSE Tutorial presents a collection of examples of how to use ROSE (found in the ROSE/tutorial directory). The ROSE Tutorial documentation is found in ROSE/docs/Rose/Tutorial directory. Note that the ROSE/tutorial contains the exact same examples as appear in the tutorial, each example may also be modified and rerun (changing either the example translators or the inputs to the examples). The ROSE Tutorial can be found at (link to LaTeX document):
  ROSE Tutorial (postscript version) or
  ROSE Tutorial (html version) .
  The tutorial documentation is built in the following steps:
  1. actual source code for each example translator in the ROSE/tutorial directory is included into the tutorial documentation
  2. each example is compiled
  3. inputs to the examples are taken from the ROSE/tutorial directory
  4. output generated from running each example is placed into the tutorial documentation.
     
• ROSE HTML Reference: Intermediate Representation (IR) documentation (these web pages)
  This web documentation presents the detail interfaces for each IR nodes (documentation generated by Doxygen). The ROSE HTML Reference documentation is found in ROSE/docs/Rose directory and is only available as html documentation (postscript would be prohibatively large and unwieldy). The ROSE HTML Reference can also be found at (link to main web page):
  ROSE HTML Reference (html version only) .
  
• ROSE Email Lists
  We have three mailing lists for core developers (those who have write access to the internal repository), all developers (anyone who has write access to the internal or external repository) and all users of ROSE (respectively). They are:
  (rose-core *at* nersc *dot* gov), web interface: https://mailman.nersc.gov/mailman/listinfo/rose-core
  (rose-developer *at* nersc *dot* gov), web interface: https://mailman.nersc.gov/mailman/listinfo/rose-developer
  (rose-public *at* nersc *dot* gov), web interface: https://mailman.nersc.gov/mailman/listinfo/rose-public
  

---