.:developers:home:module

From ADPAA
Revision as of 20:08, 26 April 2022 by Ltwohey (talk | contribs)
Jump to navigation Jump to search

Adding A New Module to ADPAA

Quick Reference

The short list for adding a module to ADPAA:

  1. Write a program that outputs data in ADPAA format (bulbtemp.py)
  2. Type ADPAA -b source to update
  3. Create a directory for the script in the appropriate subdirectory/data level (Level1, Level2, Level3, Level4) in the ADPAA src directory (*/ADPAA/src/*/) (~/CoPAS/ADPAA/src/Level3/bulbtemp/bulbtemp.py)
  4. Type svn add [directory]/ where the directory in [brackets] is replaced by what you made in step 2 (from ~/CoPAS/ADPAA/src/Level3 I type svn add bulbtemp)
  5. Type svn commit [directory]/ where the directory in [brackets] is replaced by what you made in step 2 (from ~/CoPAS/ADPAA/src/Level3 I type svn commit bulbtemp)
  6. Edit the ADPAA Makefile from */src/build and add install line for appropriate data level; commit the Makefile (from /CoPAS/ADPAA/src/build/ I type svn commit Makefile)
  7. Type ADPAA -b source to update again

Detailed Steps

It is recommended that you update ADPAA both before and after adding a module. If you do not update ADPAA before, you may encounter errors when trying to add your module.

 adpaa -b source

First, create a new sub-directory for the new module in the appropriate ADPAA directory. See Delene (2011) for information on ADPAA data levels: [1].

 cp module_file_path  
 
 Example:
 mkdir ~/CoPAS/ADPAA/src/Level3/bulbtemp/

Second, copy the new module to the newly created directory.

 cp module_file_path new_adpaa_directory
 Example:
 cp ~/scripts/bulbtemp.py ~/CoPAS/ADPAA/src/Level3/bulbtemp/bulbtemp.py