Revision as of 10:59, 4 March 2012

Introduction

This page lists the various files that may comprise a surrogate model. Each surrogate model must have a unique keyword (unique in the sense that in any given Rave installation, each keyword must be unique). For this reason it is suggested that if you code your own surrogate model and intend to distribute it to others, you give it a keyword that is specific enough to almost guarantee uniqueness. You may find it useful to code your surrogate models as specialized versions of the ones that are distributed with Rave, by making copies of their folder and all its files, renaming them to have a new keyword, and making whatever changes are necessary. (Keep in mind that any modifications you make to the existing Rave files can only be distributed under the GPLv2 license.)

The files described below are named for a surrogate model whose keyword is KEYWORD. All files related to this object must be placed in a folder named KEYWORD that is placed in the modeling directory (rave\modeling\). Optionally, you can put a number in the folder name before KEYWORD; these numbers are used to change the alphabetical order of the folders so that the surrogate models types are listed in the desired order in Rave. Any time KEYWORD appears in a file name you must replace it with the unique keyword for the object you are coding. Otherwise, the filenames must be exactly as they appear below or Rave will not recognize them. Note that some file names do not include the keyword---Rave recognizes these by their location within the KEYWORD directory.