6.2 make_new_module.pro

To simplify the creating of a new module a routine has been provided to automatically make the required module directory structure, copy all the template files from the plot_type module,and then to globally rename all the occurrences of ``plot_type'' to your new module name - in the directory and file names, and in the files themselves. The header of this procedure is:

pro make_new_module, name, MODULE_PATH=MODULE_PATH

and it is located in papco_XX/papco_lib.

name

- a string, the name of your module. PaPCo convention has been to choose names less than 10 characters long, as this name become part of the name of many procedures and functions in your module. The name should indicate mission and instrument, such as polar_mfe, \lanl_gps, \crres_meb etc.

MODULE_PATH

- a keyword, if set it contains the string of the path where new new module will be written. If you use the special string ``own'' then the module will be written into your papco_user_XX/papco_user_modules directory (this is the preferred place for new user modules). If not set, the new module is written into the standard module directory of PaPCo: papco_XX/papco_modules.

Using this procedure greatly simplifies the writing of a module, as most of the editing and copying tasks are performed automatically. In this way adherence to the PaPCo naming conventions for the module is also guaranteed. USE OF THIS ROUTINE IS STRONGLY ADVISED.

N.B.: This procedure makes use of a UNIX system call sed and is not portable to other operating systems at this stage. An IDL only version of this routine is being planned.

Nothing of course prevents you from doing this manually too! In the description that follows, you can omit each step 1 if you have used the automatic make_new_module routine.