sphinx/reposetup.rst

   1 First select what kind of operating system you are using, and then choose a
   2 download server close to you:
   3
   4 .. include:: sources_lists
   5
   6 .. raw:: html
   7
   8   <div class="nojavascriptinstructions">
   9   This form requires javascript. If disabled, incomplete instructions are
  10   displayed below</div>
  11   <div id="repoconfig">
  12   <div class="nojavascriptinstructions">
  13   Instructions for Debian-derived systems
  14   </div>
  15   <p>Select desired components:<br />
  16   <table><tr>
  17   <td><input type="radio" name="components" value="libre"></td>
  18   <td><strong>only</strong> software with guaranteed freedoms<br />
  19     <span style=font-size:75%>all packages are
  20     <a href="http://www.debian.org/social_contract#guidelines">DSFG</a>-compliant,
  21     with permission to use, modify, re-distribute under any condition</span></td></tr>
  22   <tr><td><input type="radio" name="components" value="full"></td>
  23   <td>all software<br />
  24     <span style=font-size:75%>
  25     individual packages may have restrictive licenses and you are required to
  26     check license-compliance manually
  27     </span></td></tr>
  28   </table>
  29   <div class="reposetup">
  30
  31 You can enable NeuroDebian on your system by simply copying and pasting the
  32 following two commands into a terminal window. This will add the NeuroDebian
  33 repository to your native package management system, and you will be able to
  34 install neuroscience software the same way as any other package.
  35
  36 .. raw:: html
  37
  38   <pre id="code">
  39   After selecting a release the setup code will be shown here.
  40   </pre>
  41
  42 Now you can update the package index and you are ready to install packages.
  43 Simply execute the following command in a terminal::
  44
  45   sudo apt-get update
  46
  47 You are ready to go -- enjoy NeuroDebian!
  48
  49 .. note::
  50
  51   Not every package is available for all distributions/releases. For information
  52   about which package version is available for which release and architecture,
  53   please have a look at the corresponding package pages.
  54
  55 .. raw:: html
  56
  57   </div> <!-- end reposetup -->
  58   </div> <!-- end repoconfig -->
  59
  60   <div id="vmsetup">
  61   <div class="nojavascriptinstructions">
  62   Instructions for non-Debian systems
  63   </div>
  64
  65 For all non-Debian operating systems we recommend to deploy NeuroDebian as a
  66 `virtual appliance`_ (virtual machine) -- this will only take a few minutes.
  67 On all modern hardware (built within
  68 the last 3-4 years) a virtual appliance is a convenient solution to run
  69 NeuroDebian simultaneously with the primary operating system -- without
  70 noticeable performance loss. To start using NeuroDebian:
  71
  72 1. Download this image file:
  73
  74 .. raw:: html
  75
  76   <div id="vmimagedownload">
  77   <a href="http://neuro.debian.net/debian/vm/">NeuroDebian images</a>
  78   </div>
  79
  80 2. Import this image into VirtualBox_. If you do not have VirtualBox_
  81    installed yet, visit the `VirtualBox download page
  82    <http://www.virtualbox.org/wiki/Downloads>`_ and get an installer for your
  83    system (installers for Windows, Linux, Mac and Solaris are available).
  84
  85 3. Finish the configuration by following :ref:`the instructions on setting up
  86    the virtual appliance <chap_vm>`. `[Virtual machine
  87    setup video tutorial] <http://www.youtube.com/watch?v=eqfjKV5XaTE>`_
  88
  89
  90
  91
  92 You are ready to go -- enjoy NeuroDebian!
  93
  94 .. note::
  95
  96   If you want a verified stable (but older) virtual appliances based
  97   on `Debian 6.0 (squeeze)`_ release, download one of the image files
  98   listed below.
  99
 100   * `NeuroDebian 6.0.6 image (32bit)
 101     <http://neuro.debian.net/debian/vm/NeuroDebian_6.0.6_i386.ova>`_ [~559MB]
 102
 103   * `NeuroDebian 6.0.6 image (64bit)
 104     <http://neuro.debian.net/debian/vm/NeuroDebian_6.0.6_amd64.ova>`_ [~576MB]
 105
 106 .. raw:: html
 107
 108   </div> <!-- end vmsetup -->
 109
 110 .. _virtual appliance: http://en.wikipedia.org/wiki/Virtual_appliance
 111 .. _VirtualBox: http://www.virtualbox.org
 112
 113 .. raw:: html
 114
 115   <script type="text/javascript">
 116   function createvmdownload(rel, mir) {
 117         var img_version = '7.8.0';
 118         var img_suffix;
 119         var base_url;
 120         var img_url;
 121         var md5sum_url;
 122         if (rel == 'win32') {
 123             img_suffix = 'i386';
 124         } else {
 125             img_suffix = 'amd64';
 126         };
 127         if(mir in mirrors) {
 128             base_url = mirrors[mir] + '/vm/';
 129             img_url = base_url + 'NeuroDebian_' + img_version + '_' + img_suffix + '.ova';
 130             md5sum_url = base_url + 'MD5SUMS';
 131         } else {
 132             return 'Internal error';
 133         };
 134         return '<blockquote><a href="' + img_url
 135                + '">Virtual applicance image</a> [<a title="Verify image integrity by dowloading this file and running `md5sum -c MD5SUMS`" href="'
 136                + md5sum_url
 137                + '">MD5SUM</a>, <a title="Verify authenticity of the MD5SUM file by downloading this file and running `gpg –verify MD5SUMS.gpg`" href="'
 138                + md5sum_url + '.gpg">MD5SUM.gpg</a>]</blockquote>' ;
 139
 140   };
 141
 142   function createrepourl(rel, mir, comp) {
 143     if(mir in mirrors) {
 144         var retrepo = "wget -O- http://neuro.debian.net/lists/" + rel + "."
 145          + mir + "." + comp + " | sudo tee /etc/apt/sources.list.d/neurodebian.sources.list\n"
 146          + "sudo apt-key adv --recv-keys --keyserver hkp://pgp.mit.edu:80 0xA5D32F012649A5A9\n";
 147         return retrepo;
 148     }
 149
 150   };
 151
 152   function update_by_form() {
 153      var rel = $("#release").val();
 154      var mir = $("#mirror").val();
 155      var comp = $('input[name="components"]:checked').val();
 156      if (rel != '' && mir != '') {
 157         if (rel in {'win32':'', 'win64':'', 'mac':''}) {
 158             $('#vmimagedownload').html(createvmdownload(rel, mir));
 159             $('#vmsetup').slideDown();
 160             $('#repoconfig').slideUp();
 161         } else {
 162             $('#vmsetup').slideUp();
 163             $('#repoconfig').slideDown();
 164             if (comp == undefined) {
 165               $('.reposetup').slideUp();
 166             } else {
 167               $('#code').text(createrepourl(rel, mir, comp));
 168               $('.reposetup').slideDown();
 169             }
 170         };
 171      }
 172      else
 173      {
 174         $('#repoconfig').slideUp();
 175         $('#vmsetup').slideUp();
 176      };
 177   };
 178
 179   $(document).ready(function($) {
 180      update_by_form();
 181      $('#repoconfig').hide()
 182      $('.reposetup').hide();
 183      $('#vmsetup').hide()
 184      $('#release').change(update_by_form);
 185      $('#mirror').change(update_by_form);
 186      $('input[name=components]:radio').change(update_by_form);
 187   });
 188
 189   </script>