:orphan:

.. _ahelp_install_bootcamp_data.tcsh:

**************************
install_bootcamp_data.tcsh
**************************

.. contents:: :local:


| 

    

install_bootcamp_data.tcsh    - install AFNI bootcamp data packages  
=====================================================================

.. code-block:: none

    
       An interface for installing the AFNI bootcamp data.  The install files
       will be based on the contents of the relevant hash file.
    
       1. create a new data directory to hold tgz files (afni_boot_packages)
          if it does not exist
          - afni_boot_packages can be deleted at the end using "-do_clean yes"
    
       2. download a list of data files needed for the bootcamp into:
             afni_boot_packages
          this list is contained in the downloaded hash file
          - use "-do_download no" to skip the download step
    
       3. for each needed package that does not exist or is not current :
             - download that (usually tgz) file into 'afni_boot_packages'
    
       4. if requested, extract the tgz packages under the -install_root directory
          - use "-do_install yes" to extract the tgz packages
          - use -install_root to specify where to install the packages
            default: -install_root $HOME
    
       5. if requested, remove the afni_boot_packages download directory tree
          - use "-do_clean yes" to remove the download directory
    

terminal options:                                                
=================================================================

.. code-block:: none

    
          -help                : show this help
          -hist                : show the program modification history
          -ver                 : show the program version
    
       main options:
    
          -do_download yes/no  : specify whether to download new packages
    
                default: -do_download yes
                example: -do_download no
    
             Use this option to control whether package (tgz) files are
             downloaded from the AFNI site.
    
          -do_install  yes/no  : specify whether to install new packages
    
                default: -do_install no
                example: -do_install yes
    
             Use this option to control whether package (tgz) files are
             extracted into the install_root directory.
    
             See -install_root.
    
          -do_clean yes/no     : remove downloaded files afterward
    
                default: -do_clean no
                example: -do_clean yes
    
             Specify whether to remove the download directory tree:
                afni_boot_packages
             Any new execution would require downloading new packages.
    
          -echo                : set echo in the script
    
             Use this to become very verbose, as if the script were run (continued)
             with "tcsh -x".  Each shell command is output for it is executed.
    
          -hash_file HFILE     : specify an alternate hash file
    
                default: -hash_file afni_boot_sha256sum.txt
                example: -hash_file bootcamp_alternate_hash.txt
    
             Use this option to specify an alternate file with checksums.
             The file has 2 columns, check sums (hash values) and corresponding
             file names.  This hash file must exist under:
    
                https://afni.nimh.nih.gov/pub/dist/edu/data
    
          -hash_prog PROG      : specify an alternate hash program
    
                default: -hash_prog sha256sum
                example: -hash_prog sha1hmac
    
             Use this option to specify an alternate hashing program.
    
          -install_root  IDIR  : specify where to install the packages
    
                default: -install_root $HOME
                example: -install_root ~/my_afni_data
    
             Use this option to control which directory packages are extracted
             into.  By default, it is the users $HOME directory.
    
          -verb LEVEL          : specify a verbosity level
    
                default: -verb 1
                example: -verb 2
    
             Use this option to specify an alternate hashing program.
    

examples:                                                        
=================================================================

.. code-block:: none

    
          1. download and install (download packages and install them)
             ('-do_download yes' is set by default)
    
                install_bootcamp_data.tcsh -do_install yes
    
          2. ... and clean up afterwards (remove downloaded tgz files)
    
                install_bootcamp_data.tcsh -do_install yes -do_clean yes
    
          3. download and install, but install them under ~/my_data
    
                install_bootcamp_data.tcsh -do_install yes -install_root ~/my_data
    
          4. only download the packages (anything that is not already current)
    
                install_bootcamp_data.tcsh -do_download yes
    
          5. only install pre-downloaded packages
    
                install_bootcamp_data.tcsh -do_download no -do_install yes
    
          6. specify an alternate hash file
    
                install_bootcamp_data.tcsh -hash_file short_sha256sum.txt
    
          7. specify an alternate hash file and an alternate hash program
    
                install_bootcamp_data.tcsh             \
                   -hash_prog sha1hmac                 \
                   -hash_file boot_hash_sha1hmac.txt
    
       R Reynolds, Jan, 2026