.:SVNInstall:home: Difference between revisions

From ADPAA
Jump to navigation Jump to search
No edit summary
No edit summary
 
(12 intermediate revisions by 3 users not shown)
Line 4: Line 4:
http://sourceforge.net/projects/adpaa/.  The binary distribution is available
http://sourceforge.net/projects/adpaa/.  The binary distribution is available
as a single compressed archive file, ADPAA.tar.gz.  The ADPAA.tar.gz file can
as a single compressed archive file, ADPAA.tar.gz.  The ADPAA.tar.gz file can
be download from http://sourceforge.net/projects/adpaa/files/.  Details
be download from http://sourceforge.net/projects/adpaa/files/.  Details and
instructions are given below to download the ADPAA binary distribution.
instructions are given below to download the ADPAA binary distribution.


Line 11: Line 11:
is designed to run on the Linux OS and has been tested on Redhat, Fedora, and
is designed to run on the Linux OS and has been tested on Redhat, Fedora, and
Ubuntu.  On Linux, the svn command can be executed from a shell terminal.
Ubuntu.  On Linux, the svn command can be executed from a shell terminal.
Typical svn command related to ADPAA are given below.
Typical svn commands related to ADPAA are given below.


You can download the binary cplot and cplot2 programs if you only need only need
You can download the binary cplot and cplot2 programs if you only need
to display and analyze data, instead of processing raw aircraft data files. You
to display and analyze data, instead of processing raw aircraft data files. You
can also use a windows Subversion client to download the source code if you like
can also use a windows Subversion client to download the source code if you like
Line 45: Line 45:


Source Code Distribution Download Commands (Read/Write Access):
Source Code Distribution Download Commands (Read/Write Access):
   svn checkout --username=name svn+ssh://name@svn.code.sf.net/p/adpaa/code/trunk adpaa-code
   svn checkout svn+ssh://name@svn.code.sf.net/p/adpaa/code/trunk adpaa-code
     Where name is developer's username.  The lead developer, David Delene, has
     Where name is developer's username.  The lead developer, David Delene, has
     to give include you as a ADPAA developer.
     to give include you as a ADPAA developer.


Update Existing Source In Software Repository:
Update Existing Source From Software Repository:
   svn update
   adpaa update source
 
 
Define System Variables (/etc/profile and/or /etc/csh.cshrc):
Define System Variables (/etc/profile and/or /etc/csh.cshrc):
   ADPAA_DIR=/usr/local/ADPAA
   ADPAA_DIR=/usr/local/ADPAA
Line 67: Line 69:
     2.)  System variable "verbose_mode" can be set to:
     2.)  System variable "verbose_mode" can be set to:
         0 - Suppress output
         0 - Suppress output
         1 - Provide additional information to termial.
         1 - Provide additional information to terminal.
     3.)  System variable "virtual_machine" can be set to:
     3.)  System variable "virtual_machine" can be set to:
         0 - Force use of the binary version of ADPAA (No IDL Licence)
         0 - Use the source code version of ADPAA (Requires IDL Licence)
            Compiles IDL code before execution.
        1 - Use the binary version of ADPAA (No IDL Licence)
             Use binary IDL files from /usr/local/ADPAA/sav
             Use binary IDL files from /usr/local/ADPAA/sav
        1 - Force use of the source code version of ADPAA (Requires IDL Licence)
            Compiles IDL code before execution.


Building:
Building:
Line 82: Line 84:
Build Requirements:
Build Requirements:
   An Interactive Data language (IDL) license is required to compile the ADPAA
   An Interactive Data language (IDL) license is required to compile the ADPAA
   source code.  Some modules are able to be compile using GNU Data Language
   source code.  Some modules are able to be compiled using GNU Data Language
   (GDL).  While the majority of ADPAA code is written in IDL, ADPAA contains
   (GDL).  While the majority of ADPAA code is written in IDL, ADPAA contains
   perl, BASH, CSH, C, FORTRAN, python, and tcl code.
   perl, BASH, CSH, C, FORTRAN, python, and tcl code.
Line 102: Line 104:
     process_all_iphex
     process_all_iphex


Committing to Database:
===For ADPAA Developers:===
 
Committing Changes to Existing File to the ADPAA SVN Repository:
  Be in the directory (Within ${ADPAA_DIR}/src) where the
  file (for example somethingnew) is located that you want to commit.
  The file you want to commit needs to be currently located in this directory.
 
   svn commit INSTALL
   svn commit INSTALL
    ADPAA developer can update a file, such as 'INSTALL', in the SVN database.
 
    Please provide a comment on what is being changed.
  ADPAA developers can update a file, such as 'INSTALL', in the SVN repository.
  Please provide a comment on what is being changed.
 
Adding New Files to the ADPAA SVN Repository:
  Be in the directory (Within ${ADPAA_DIR}/src) where the
  file (for example somethingnew) is located that you want to commit.


Adding to Database:
   svn add somethingnew
   svn add somethingnew
    New files need to be added to the database before committing it.
 
  New files need to be added to the repository before being committed.
 
ADPAA Version
  The SVN Repository gets a new version number after each commit to the repository, which is a nice feature of SVN. In contrast, GIT repository do not have version numbers due to the way branching and merging of different version are done.  The SVN Repository information is stored in the ${ADPAA_DIR}/share/version.txt file for use by programs within ADPAA, for example "adpaa -v".  The ADPAA build scripts create, for example adpaa_create_source, obtain current version information from the repository and storage the information in version.txt. If a local version of ADPAA is installed using "adpaa_install_source" the ${ADPAA_DIR}/share/version.txt file is blank since the code version is not necessary any ADPAA repository version since the code cloud be modified locally.

Latest revision as of 12:40, 23 February 2024

The Aircraft Data Processing and Analysis (ADPAA) software package is avaivalbe as a binary (compiled) distribution and a source code distribution. Both distributions are available on the Source Forge ADPAA site, http://sourceforge.net/projects/adpaa/. The binary distribution is available as a single compressed archive file, ADPAA.tar.gz. The ADPAA.tar.gz file can be download from http://sourceforge.net/projects/adpaa/files/. Details and instructions are given below to download the ADPAA binary distribution.

The latest source code of the Aircraft Data Processing and Analysis (ADPAA) package can be downloaded from SourceForge using a Subversion client. ADPAA is designed to run on the Linux OS and has been tested on Redhat, Fedora, and Ubuntu. On Linux, the svn command can be executed from a shell terminal. Typical svn commands related to ADPAA are given below.

You can download the binary cplot and cplot2 programs if you only need to display and analyze data, instead of processing raw aircraft data files. You can also use a windows Subversion client to download the source code if you like to view the code; however, the code is also viewable online via a Web browser. The use of Linux shell scripts and file system commands makes running ADPAA under Windows impossible.

Binary Distribution Download Commands:

 mkdir /usr/local/ADPAA
   Create directory if necessary.
 chown username /usr/local/ADPAA
   Change ownership if necessary
 cd /usr/local/ADPAA
   Change to ADPAA directory
 wget https://sourceforge.net/projects/adpaa/files/ADPAA.tar.gz
   Get the latest binary release
 tar -xzvf ADPAA.tar.gz
   Extract data files
 ADPAA_DIR=/usr/local/ADPAA
   Define the ADPAA System Variables (/etc/profile and/or /etc/csh.cshrc):

Source Code Distribution Download Commands (Read Access):

 Create directory /usr/local/ADPAA if necessary
   Change ownership if necessary, i.e. chown username /usr/local/ADPAA
 cd /usr/local/ADPAA
 svn checkout svn://svn.code.sf.net/p/adpaa/code/trunk adpaa-code
 cd adpaa-code
 mv src .svn ..
 cd ..
 rmdir adpaa-code

Source Code Distribution Download Commands (Read/Write Access):

 svn checkout svn+ssh://name@svn.code.sf.net/p/adpaa/code/trunk adpaa-code
   Where name is developer's username.  The lead developer, David Delene, has
   to give include you as a ADPAA developer.

Update Existing Source From Software Repository:

 adpaa update source


 

Define System Variables (/etc/profile and/or /etc/csh.cshrc):

 ADPAA_DIR=/usr/local/ADPAA
 IDL_PROG=${ADPAA_DIR}/src
 idl_exe=/usr/bin/idl
 PYTHONPATH=$PYTHONPATH:${ADPAA_DIR}/src/python_lib
 SVN_EDITOR=vim
   Add /usr/local/ADPAA/bin to your PATH environmental variable.
   Export the system variables, ADPAA_DIR IDL_PROG PYTHONPATH SVN_EDITOR idl_exe.
 Notes on System Variables.
   1.)  idl_exe can be set to /usr/bin/gdl if GDL (GNU Data Language) is
        install instead of IDL
   2.)  System variable "verbose_mode" can be set to:
        0 - Suppress output
        1 - Provide additional information to terminal.
   3.)  System variable "virtual_machine" can be set to:
        0 - Use the source code version of ADPAA (Requires IDL Licence)
            Compiles IDL code before execution.
        1 - Use the binary version of ADPAA (No IDL Licence)
            Use binary IDL files from /usr/local/ADPAA/sav

Building:

 mkdir /usr/local/ADPAA/bin
 mkdir /usr/local/ADPAA/sav
 mkdir /usr/local/ADPAA/share
 cd /usr/local/ADPAA/src/build/ && ./install_adpaa.bash

Build Requirements:

 An Interactive Data language (IDL) license is required to compile the ADPAA
 source code.  Some modules are able to be compiled using GNU Data Language
 (GDL).  While the majority of ADPAA code is written in IDL, ADPAA contains
 perl, BASH, CSH, C, FORTRAN, python, and tcl code.

Testing ADPAA Installation:

 Start the cplot2 GNU for displaying data from files.
   cplot2
 Conduct Level 1 processing of raw M300 data system file.
   cp -r /usr/local/ADPAA/src/TestData/FlightData ~
   cd ~/FlightData/20140429_152103/PostProcessing
   process_raw 14_04_29_15_21_03.sea
 Conduct Level 1-4 processing of raw M300 data system file.
   cp -r /usr/local/ADPAA/src/TestData/FlightData ~
   cd ~/FlightData/20140429_152103/PostProcessing
   process_all 14_04_29_15_21_03.sea
 Conduct processing of a aircraft flight.
   cp -r /usr/local/ADPAA/src/TestData/FlightData ~
   cd ~/FlightData/20140429_152103/
   process_all_iphex

For ADPAA Developers:

Committing Changes to Existing File to the ADPAA SVN Repository:

 Be in the directory (Within ${ADPAA_DIR}/src) where the
 file (for example somethingnew) is located that you want to commit.
 The file you want to commit needs to be currently located in this directory.
 svn commit INSTALL
 
 ADPAA developers can update a file, such as 'INSTALL', in the SVN repository.
 Please provide a comment on what is being changed.

Adding New Files to the ADPAA SVN Repository:

 Be in the directory (Within ${ADPAA_DIR}/src) where the
 file (for example somethingnew) is located that you want to commit.
 svn add somethingnew
 New files need to be added to the repository before being committed.

ADPAA Version

 The SVN Repository gets a new version number after each commit to the repository, which is a nice feature of SVN. In contrast, GIT repository do not have version numbers due to the way branching and merging of different version are done.  The SVN Repository information is stored in the ${ADPAA_DIR}/share/version.txt file for use by programs within ADPAA, for example "adpaa -v".  The ADPAA build scripts create, for example adpaa_create_source, obtain current version information from the repository and storage the information in version.txt. If a local version of ADPAA is installed using "adpaa_install_source" the ${ADPAA_DIR}/share/version.txt file is blank since the code version is not necessary any ADPAA repository version since the code cloud be modified locally.