| 1 | = VSO Software = |
| 2 | |
| 3 | Many VSO packages are available as installers at http://vso1.nascom.nasa.gov/installers/ . |
| 4 | |
| 5 | The complete set of VSO modules are available through anonymous CVS. |
| 6 | |
| 7 | == Connecting via CVS == |
| 8 | |
| 9 | 1. Install a CVS client |
| 10 | |
| 11 | In order to get the VSO Data Provider interface and code examples you should have a cvs client. If you don't you can get one at: |
| 12 | |
| 13 | http://www.cvshome.org |
| 14 | |
| 15 | If this is problematic for you [wiki:ContactUs let us know] and we will package up a current set for you. |
| 16 | |
| 17 | 2. Connect to the VSO CVS server |
| 18 | |
| 19 | a. Set the environmental variable CVSROOT to |
| 20 | {{{ |
| 21 | :pserver:anonymous@solarch.tuc.noao.edu:2401/vtarc1/vso/cvsroot |
| 22 | }}} |
| 23 | older versions of CVS may require |
| 24 | {{{ |
| 25 | :pserver:anonymous@solarch.tuc.noao.edu/vtarc1/vso/cvsroot |
| 26 | }}} |
| 27 | For example: |
| 28 | {{{ |
| 29 | # in bash/ksh |
| 30 | > export CVSROOT=:pserver:anonymous@solarch.tuc.noao.edu:2401/vtarc1/vso/cvsroot |
| 31 | # in csh: |
| 32 | > setenv CVSROOT :pserver:anonymous@solarch.tuc.noao.edu:2401/vtarc1/vso/cvsroot |
| 33 | }}} |
| 34 | |
| 35 | b. login to CVS |
| 36 | {{{ |
| 37 | > cvs login |
| 38 | }}} |
| 39 | |
| 40 | c. Hit the enter key when prompted for a password |
| 41 | |
| 42 | d. Download everything, or an individual module. |
| 43 | {{{ |
| 44 | # download everything |
| 45 | > cvs checkout vso |
| 46 | # download the 'DataProvider' inheritable |
| 47 | > cvs checkout DataProvider |
| 48 | }}} |
| 49 | This will create the directory 'vso' in the current directory, and the directory structure of the modules requested. |
| 50 | |
| 51 | 3. Install the modules |
| 52 | |
| 53 | a. Change to the module directory |
| 54 | {{{ |
| 55 | # for the DataProvider inheritable |
| 56 | > cd vso/DataProviders/Inheritable/Perl |
| 57 | }}} |
| 58 | |
| 59 | b. Run the configuration program |
| 60 | {{{ |
| 61 | > perl Makefile.PL |
| 62 | }}} |
| 63 | |
| 64 | c. Build, test, and install the module. |
| 65 | {{{ |
| 66 | > make |
| 67 | > make test |
| 68 | > make install |
| 69 | }}} |
| 70 | |
| 71 | d. Read the documentation. You may need to examine the module's README file for its full name. |
| 72 | {{{ |
| 73 | # modules are installed in the 'Physics::Solar::VSO' heiarchy, but a VSO |
| 74 | # module may include more than one perl package |
| 75 | |
| 76 | # continuing with the DataProvider example: |
| 77 | > perldoc Physics::Solar::VSO::DataProvider |
| 78 | }}} |
| 79 | |
| 80 | ----- |
| 81 | |
| 82 | === Note: === |
| 83 | |
| 84 | In the case of Data Providers, it may also be worthwhile to look in the module's Examples directory, or to download some of the other VSO Data Provider code to use as a reference: |
| 85 | |
| 86 | {{{ |
| 87 | > cvs checkout NSO |
| 88 | > cvs checkout OVRO |
| 89 | > cvs checkout SDAC |
| 90 | > cvs checkout SHA |
| 91 | > cvs checkout NGDC |
| 92 | }}} |
| 93 | |
| 94 | Most modules also contain a README file, which contains basic information about usage, and may provide additional information that is specific to that module. |