= Rappture Documentation =

This page contains reference documentation for the Rappture toolkit.  Make sure you understand the big picture ([wiki:whatIsRappture What Is Rappture?]) before you get in too deep here.

== Rappture Tutorials ==

The following tutorials teach the basic concepts behind Rappture and take you through several examples in Python, Fortran, and other languages:
 * [http://hubzero.org/resources/381 HUBbub 2011: Creating and Deploying Scientific Tools] (short course)
 * [http://nanohub.org/resources/14671 NCN Software Boot Camp 2012] (longer version)

== Rappture Examples ==

There are lots of examples included in the Rappture code distribution.  You can [source:trunk/examples/ browse these online].  Or, you might copy them into your working directory within a nanoHUB workspace as follows:
{{{
% cp -r /apps/share64/debian7/rappture/current/examples .
}}}

== Rappture GUI Elements ==

The first step in building a Rappture application is to describe the inputs and outputs for your tool:
 * [wiki:rappture_xml_elements Rappture GUI XML Elements]

== Rappture APIs ==

The second step is to access the inputs/outputs within your tool via the Rappture library.  Pick your favorite programming language:

 * [wiki:rappture_ccpp_api Rappture-C/C++ API]
 * [wiki:rappture_fortran_api Rappture-Fortran API]
 * [wiki:rappture_python_new_api New Rappture-Python API] 
 * [wiki:rappture_python_api Old Rappture-Python API]
 * [wiki:rappture_tcl_api Rappture-Tcl API]
 * [wiki:rappture_matlab_api Rappture-Matlab / Rappture-Octave API]
 * [wiki:rappture_perl_api Rappture-Perl API]
 * [wiki:rappture_ruby_api Rappture-Ruby API]
 * [wiki:rappture_java_api Rappture-Java API]
 * [wiki:rappture_r_api Rappture-R API]

== Utility Commands ==

These utilities are installed along with Rappture to help process run.xml files:

 * [wiki:rpdiff rpdiff] - compare two run.xml files
 * [wiki:rptimes rptimes] - create SQLite database of run times from run.xml files

== Building Rappture (Linux and MacOS X) ==

 * [wiki:rappture_installation_hardway Compiling] Rappture Runtime (dependencies) and Rappture (toolkit libraries)
 * [wiki:BuildingRenderServer Building a render server] for Rappture

== File !Download/Upload ==

Rappture has a unique mechanism for [wiki:FileDownloadUpload file download/upload]
when applications are running within a Web browser.  The application itself acts
as a Web server, and a '''filexfer''' "helper" applet is sent to the client's browser.
[wiki:FileDownloadUpload Read more...]

== Passing Parameters from URL ==

There is a [wiki:ParameterPassing generic mechanism] used to pass parameters into tools on the hub.  Using this same mechanism, you can tell Rappture to execute driver files, load run files, load a file into an input parameter, and more.  [wiki:RapptureApi More details...]

== Geospatial Features (GABBs Project) ==

Current working design specifications:

 * [wiki:MapObjectXML Rappture Map XML]
 * [wiki:MapObjectAPI Map Object API]
 * [wiki:MapViewer Map Viewer API]

 * [wiki:maptodo TODO list for Hubzero map functionality]

Old design documents:

* [https://nanohub.org/infrastructure/rappture/attachment/wiki/Documentation/mapexplorerapi.pdf Old Map Explorer API]
* [wiki:MapObjectOld Old Map Object]
* [wiki:roadmapformapping Old roadmap for map rendering in Rappture]

== Proposed Dataset XML Element ==
This page describes a proposed dataset object for rappture.
[wiki:rp_xml_ele_dataset Read more...]

== Running Windows tools in WINE ==
This page describes problems running windows tools in WINE
[wiki:UsingWine Read more...]

== Uncertainty Quantification Internals Documentation ==
[wiki:UQ Uncertainty Quantification Integration with Rappture]

== Coming Soon: Rappture 2.0 ==

We're working on a complete redesign of Rappture, combining the XML description and the code that accesses this description, making it easier to integrate Rappture into your applications.  Here are some notes on the [wiki:rappture_core Rappture Core Object Design].

Work-In-Progress:
 * [wiki:ReleaseNotes Release Notes]
 * [wiki:nanoVis nanoVis]
 * [wiki:pqg Publication Quality Graphs]
 * [wiki:params How the pass parameters to tools]
 * [wiki:dbchoice Use databases from Rappture]
 * [wiki:renderserverstodo TODO list for Hubzero renderservers]

== Coming Soon: Rappture Services ==
 * [wiki:services Services proposal]

== Simulation Results ==

 * [wiki:SaveResults Save Results]
 * [wiki:LoadPrevious Load Previous Results]
 * [wiki:ShareResults Share Results]