OpenBasin Overview

  • OpenBasin Installation
  • Other Setup Details
  • Adding Data
  • Making Changes
  • OpenBasin Distribution Overview
    • Included Scripts Overview
      [dir: openbasin/extra/scripts]
    • Component Overview
      • PHP
      • Perl
      • PostgreSQL
      • Smarty
        dir: openbasin/smarty
      • EzPDF
        dir: openbasin/extra/scripts/ezpdf
    • Object Overview
      dir: openbasin/obj
      • Core Objects
          Always used
        • OpenBasin.php
        • Explanation How/when to use Link to Documentation
      • Display Objects
          Used to add OpenBasin functionality to a web page
        • Graph.php
        • StationDisplay.php
        • StickFigure.php
        • Tabular.php
      • Station Objects
          Used when adding new station types
        • Station.php
      • Sensor Objects
          Used when adding new sensor types
        • Sensor.php
      • Utiltiy Objects
          Used when programming new functionality
        • Dataset.php
        • Dataspan.php
        • Key.php
        • PopupWindow.php
        • Script.php
        • StationList.php
      • Other Objects
        • Region.php
    • Admin Overview
      dir: openbsain/admin
    • DB Overview
      dir: openbsain/db
    • Dataloading Scripts overview
      dir: openbasin/bin
      dir: openbasin/plugins
    • Documentation Overview dir: openbasin/documentation
Author: Matthew Maxwell
Date: October 25, 2004

OpenBasin Installation
 

The OpenBasin installation process is covered extensively by the Installation HOWTO. Please refer to that document for information regarding the inital installation of OpenBasin.

Other Setup Details
 

After installing OpenBasin there are still a number of other steps that must be taken before using OpenBasin. The first is configuring the ob_config.php file that was created during installation. More details on this may be found in the Edit ob_config.php HOWTO.

Included with the OpenBasin download is a software package called Smarty. Smarty is a templating engine for PHP documents. The OpenBasin Administration pages and many of the bundled scripts require Smarty. It is important to note that OpenBasin itself does not rely on the Smarty software; however, many optional components do. Since the OpenBasin Administration pages simplify the use of OpenBasin immensely we reccomend installing Smarty also.

Installing Smarty is actually fairly trivial.

  1. Switch directories to the /openbasin/smarty directory
    cd smarty (Assuming your current directory is the OpenBasin base directory)
  2. Untar the Smarty file
    tar xzf Smarty-2.5.0.tar.gz
  3. Switch directories to the /openbasin/smarty/Smarty-2.5.0 directory
    cd Smarty-2.5.0
  4. More info here

Adding Data
 

The next step in creating a usable copy of OpenBasin is adding the appropriate data into the database. In OpenBasin, most data is owned by a paticular station. For example, if we had a reservoir named "Storage" we would first have to create a station in OpenBasin called "storage" before adding that reservoir's data into the database. Through this method, OpenBasin can keep track of what data belongs where. There is also such a thing as shared data where multiple stations can share data from one location; however, discussion of that topic is beyond the scope of this tutorial.

Thus, the process of adding data to the database is divided into two steps. Adding the associated station into OpenBasin and adding data to that station. The next two sections will deal with those two topics. Additionally, the topic of automating data insertion will be discussed.

Adding Stations to OpenBasin
 

The process of adding stations into the database is covered in the Using the admin pages HOWTO under the heading Adding Stations

Importing Data into the Database
 

The data for stations are stored within the database given when the database was created.

technical contact: Matthew Maxwell
general contact:

Wisp-router.com