Difference between revisions of "Users Guide"

From VistrailsWiki
Jump to navigation Jump to search
(41 intermediate revisions by 7 users not shown)
Line 1: Line 1:
There is not much documentation right now, but some of the documentation for an older version of the system is still useful: [http://www.sci.utah.edu/~vgc/vistrails/pub/vistrails-tutorial.pdf]. Also, our older webpage has links to a number of papers that contain information on the various features of the system: [http://www.sci.utah.edu/~vgc/vistrails/old.html].
If you are using, or planning to use, VisTrails, please subscribe to the [[MailingLists|vistrails users mailing list]].


Alternatively, you can subscribe to the vistrails users mailing list. Details are on how to do that, are available [http://www.vistrails.org/index.php/Downloads here].
Up-to-date user's guides in online and pdf versions are available here:


{| class="wikitable" style="margin-left: 20px;"
|v2.2 (Current Release)
|[http://www.vistrails.org/usersguide/v2.2/html html]
|[http://www.vistrails.org/usersguide/v2.2/html/VisTrails.pdf pdf]
|-
|dev (Master Branch)
|[http://www.vistrails.org/usersguide/dev/html html]
|[http://www.vistrails.org/usersguide/dev/html/VisTrails.pdf pdf]
|}


 
Older Releases:
== Getting_Started ==
{| class="wikitable" style="margin-left: 20px;"
 
|v2.1
VisTrails is available on Windows XP, Mac OS X, and Linux. These
|[http://www.vistrails.org/usersguide/v2.1/html html]
versions all have the same functionality and only differ in user
|[http://www.vistrails.org/usersguide/v2.1/html/VisTrails.pdf pdf]
interface as noted throughout this document.
|-
 
|v2.0
There are different download options, available
|[http://www.vistrails.org/usersguide/v2.0/html html]
[http://www.vistrails.org/index.php/Downloads here]. It is substantially
|[http://www.vistrails.org/usersguide/v2.0/html/VisTrails.pdf pdf]
easier to start with a binary version, and this is encouraged for first-time
|-
users. If you decided on a source version (maybe because a binary version
|v1.7
for your architecture is not available at this time), please follow the
|[http://www.vistrails.org/usersguide/v1.7/html html]
instructions on building the software from source available
|[http://www.vistrails.org/usersguide/v1.7/html/VisTrails.pdf pdf]
[http://www.vistrails.org/index.php/Building_From_Source here].
|}
 
Starting up the binary version is system depended. On Windows XP and Mac OS X, it requires clicking on the application icon. To start the binary version on any system, you should change directory to "src/vistrails/trunk/vistrails/", where the "vistrails.py" file is available. You can start VisTrails with the following command: "python vistrails.py -l".
 
Depending on a number of factors, it can take a few seconds for the system to start up. You will see a splash screen while that happens. On the console, you will see some messages that show the packages being loaded. On my Mac OS X system, I get the following:
 
  Initializing  vtk
  Initializing  pythonCalc
  Initializing  spreadsheet
  Loading Spreadsheet widgets...
    ==> Successfully import <Basic Widgets>
    ==> Successfully import <Image Viewer>
    ==> Successfully import <VTK Viewer>
    ==> Successfully import <HTML Viewer>
    ==> Successfully import <SVG Widgets>
 
 
Also, I get two separate windows, the VisTrails Builder:
 
[[Image:VisTrails_Builder.png | 750px]]
 
And the VisTrails Spreadsheet:
 
[[Image:VisTrails_Spreasheet.png | 750px]]
 
 
You are now ready to load a vistrail inside the system. Go to the Builder, and under "File",
there will be an "Open" option. After clicking it, you will be giving a list of files, and you can
load any of the vistrails there. For instance, if you load the "vtk_book_3rd_p189.xml", your
screen will look like this:
 
[[Image:VisTrails_Builder_with_vtk_book_3rd_p189.xml.png | 750px]]
 
Each "oval" correspond to a different workflow. If you click on "final", you can "execule" that workflow
either by clicking on the execute the workflow icon: [[Image:execute_workflow_icon.png | 50px]].
 
More details on interacting with the components of VisTrails are available below.
 
== VisTrails Builder ==
 
You can create and edit dataflows (workflows) using
the Vistrail Builder user interface.
The dataflow specifications are saved in
a repository that can be either local or remote. For now, we
only discuss local repository here, which are "xml" files by
default.
 
A key feature of VisTrails is the support for
full provenance of the exploration process. For this,
we introduced the notion of a visual trail, or a
vistrail.   A vistrail captures the
evolution of a dataflow---all steps followed to construct a set of
workflows. It represents several versions of a dataflow (which
differ in their specifications), their relationships, and their
instances (which differ in the parameters used in each particular
execution). VisTrails uses a change-based model to capture provenance.
As the scientist makes modifications to a particular dataflow, the
provenance mechanism records those changes. 
Instead of storing a set of related dataflows, VisTrails stores the
operations or changes that are applied to the dataflows, e.g., the
addition of a module, the modification of a parameter, etc.
 
This representation is both simple and compact---it uses substantially
less space than the alternative of storing multiple versions of
a dataflow. In addition, it enables the construction of an intuitive
interface that allows scientists to both understand and interact with
the history of the dataflow through these changes.
A tree-based view allows a scientist to return to a previous version
in an intuitive way; to undo bad changes; to compare different
dataflows; and be reminded of the actions that led to a particular
result.
 
The Builder is roughly divided into three main regions. In the left, a
list of modules that can be used for building particular workflows are
listed. The middle is the main workflow interaction area, which can be
toggled to display an instance of a workflow, or the vistrail, which
corresponds to the collection of a number of different instances. On
the right, there is a context sensitive menu that can be used for
operating on the properties of what is being shown in the middle.
 
== VisTrails Modules ==
 
 
== VisTrails Spreadsheet ==
 
== Advanced Topics ==
 
=== VisTrails Packages ===
 
== Examples ==
 
=== Visualizing Quadrics ===
 
== Summary of Technical Terms ==

Revision as of 13:51, 9 July 2015

If you are using, or planning to use, VisTrails, please subscribe to the vistrails users mailing list.

Up-to-date user's guides in online and pdf versions are available here:

v2.2 (Current Release) html pdf
dev (Master Branch) html pdf

Older Releases:

v2.1 html pdf
v2.0 html pdf
v1.7 html pdf
Retrieved from "https://www.vistrails.org//index.php?title=Users_Guide&oldid=10103"