Skip to content


Personal tools
You are here: Home » Documentation » Documentation Needed

Documentation Needed

Document Actions
A list of documentation we need to develop.
  • Getting started
    • Supported platforms and key locations
    • Setting up your environment for SWIM and the IPS
    • Downloading and building the IPS and components
  • Basic IPS usage
    • Introduction to the IPS for users: terminology, organization, work flows. This should convey the way we've designed the IPS to work and help users take advantage of it rather than work against it.
    • Configuration file basics
    • Canned examples. Should describe a set of relatively simple, quick-running examples, including all inputs and outputs, with accompanying notes and documentation, and reference output. Collectively, these examples should cover every component available for the IPS. Extra bonus: these examples can double as basic test cases!
    • Running, monitoring, and analyzing IPS simulations. Interactive and batch execution, basics of using the portal to track progress (portal basics), using ElVis, making sure it ran correctly, analysis tools (eventually).
    • The default driver. A thoroughly documented default driver, capable of running most simulations of interest to SWIM in serial (i.e. not MCMD) fashion.
    • Setting up your own simulations. IPS configuration file. Component configuration files. Other inputs.
  • Available components
    • For each component: Document config file settings, other component inputs, component outputs, point(s) of contact, pointer(s) to in-depth documentation, component description documents.
    • Monitor component
    • Portal bridge component
    • FTB bridge component
  • Advanced IPS usage
    • The Complete Guide to the Portal
    • Running multiple simulations simultaneously
    • Gathering and analyzing performance data
      • ... for the IPS
      • ... for the physics tasks
    • IPS services for driver and component developers
    • Writing components. Point to thoroughly documented examples.
      • Managing multiple tasks, and task pools
    • Writing drivers. Why you should use and improve the default driver instead of writing a new one. What you need to know if you really do need to write a new one.
      • Time-stepped control flow
      • Event-based control flow
      • MCMD execution
    • Plasma state for IPS physics developers
    • Resource Usage Simulator (RUS) user's guide
  • IPS development
    • Overall design of the IPS.
    • Framework and managers
    • Resource Usage Simulator (RUS) developer's guide
  • Best practices
    • Naming things. File, simulations, etc.
  • Other tools
    • The web site. Adding web pages. Adding binary files
    • Managing mailing lists on
    • Developer tools. Trac. SVN commit emails and RSS feeds
    • Subversion how to and best practices
Created by bernhold
Last modified 2010-11-01 17:55