Developer Documentation

From VisItusers.org

Welcome to VisItland! This page provides links to a myriad of topics of interest to a VisIt developer.

Contents 1 Source code documentation 2 The Design of VisIt 2.1 Plugins 3 Software Engineering Aspects 4 Development Aspects 5 Other 6 Skeletons for future pages 6.1 The Design of VisIt 6.2 Other (find me a home!)

[edit] Source code documentation

VisIt 1.9.0	VisIt 1.10.0
Java Client API	Source code documentation Java Client API

See also: Generating source code docs using Doxygen

[edit] The Design of VisIt

• High level design
• State objects
• Design of each process in the VisIt system
  • Command Line Interface
  • Compute engine
  • The rest of the pages have not been started yet.
• An overview of AVT, the data flow network library used by VisIt's server
• Load balancing in a parallel setting
• How VisIt handles ghost data
• How scalable rendering mode works

[edit] Plugins

• There is a user-oriented overview of plugins located here.
• Adding a new plot
• Adding a new operator
• Writing a database writer
• For adding a new database, check out the "Getting Data Into VisIt" Manual.
• Explaining the abstractions behind plugins

[edit] Software Engineering Aspects

• Subversion usage and version control
  • Configuring SVN on Windows
  • Using SVN on Windows
  • Anonymous svn
• How releases are managed
• How to do testing
• Handling patches contributed from external sources
• VisIt Coding Style Guide
• Building VisIt
• Bug tracking

[edit] Development Aspects

• Debugging VisIt
  • Parallel Debugging
• Timing VisIt
• Memory management
• Using exceptions
• Extending VisIt / Examples of common development use cases
• Description of complex algorithms and data structures
• Why certain things are hard to do in VisIt
• Internationalization
• Various aspects to 3rd Party Libraries
• Time, Cycle and StateIndex Issues

[edit] Other

• How to become a VisIt developer
• Recently added Wiki pages for developers
• Porting to a parallel machine
• Setting up parallel hardware rendering
• Discussion Area for Misc Projects
• Mailing list details
  • This is currently intended only for mailing list moderators and administrators
• Platforms developers can access
• Documentation of performance issues with connected components filter

[edit] Skeletons for future pages

[edit] The Design of VisIt

• Design of each process in the VisIt system
  • Graphical User Interface
  • Viewer
  • Component Launcher
• Class Hierarchy
• Client Interfaces

[edit] Other (find me a home!)

• Changing Internal Filters From Float to Double
• VisIt 2.0 Planning
• avtAccessor
• streamline changes