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 still running an older VirtualBox 3.x, download one of the image files
  97   listed below. These older releases are distributed as a `zip` file. Please
  98   extract all files from the `.zip` file, using appropriate software
  99   for your operating system.
 100
 101   * `NeuroDebian 6.0.2 image (32bit)
 102     <http://neuro.debian.net/debian/vm/neurodebian_6.0.2_i386.zip>`_ [~545MB]
 103
 104   * `NeuroDebian 6.0.2 image (64bit)
 105     <http://neuro.debian.net/debian/vm/neurodebian_6.0.2_amd64.zip>`_ [~560MB]
 106
 107 .. raw:: html
 108
 109   </div> <!-- end vmsetup -->
 110
 111 .. _virtual appliance: http://en.wikipedia.org/wiki/Virtual_appliance
 112 .. _VirtualBox: http://www.virtualbox.org
 113
 114 .. raw:: html
 115
 116   <script type="text/javascript">
 117   function createvmdownload(rel, mir) {
 118         var img_version = '6.0.5';
 119         var img_suffix;
 120         var base_url;
 121         var img_url;
 122         var md5sum_url;
 123         if (rel == 'win32') {
 124             img_suffix = 'i386';
 125         } else {
 126             img_suffix = 'amd64';
 127         };
 128         if(mir in mirrors) {
 129             base_url = mirrors[mir] + '/vm/';
 130             img_url = base_url + 'NeuroDebian_' + img_version + '_' + img_suffix + '.ova';
 131             md5sum_url = base_url + 'MD5SUMS';
 132         } else {
 133             return 'Internal error';
 134         };
 135         return '<blockquote><a href="' + img_url
 136                + '">Virtual applicance image</a> [<a title="Verify image integrity by dowloading this file and running `md5sum -c MD5SUMS`" href="'
 137                + md5sum_url
 138                + '">MD5SUM</a>, <a title="Verify authenticity of the MD5SUM file by downloading this file and running `gpg –verify MD5SUMS.gpg`" href="'
 139                + md5sum_url + '.gpg">MD5SUM.gpg</a>]</blockquote>' ;
 140
 141   };
 142
 143   function createrepourl(rel, mir, comp) {
 144     if(mir in mirrors) {
 145         var retrepo = "wget -O- http://neuro.debian.net/lists/" + rel + "."
 146          + mir + "." + comp + " | sudo tee /etc/apt/sources.list.d/neurodebian.sources.list\n"
 147          + "sudo apt-key adv --recv-keys --keyserver pgp.mit.edu 2649A5A9\n";
 148         return retrepo;
 149     }
 150
 151   };
 152
 153   function update_by_form() {
 154      var rel = $("#release").val();
 155      var mir = $("#mirror").val();
 156      var comp = $('input[name="components"]:checked').val();
 157      if (rel != '' && mir != '') {
 158         if (rel in {'win32':'', 'win64':'', 'mac':''}) {
 159             $('#vmimagedownload').html(createvmdownload(rel, mir));
 160             $('#vmsetup').slideDown();
 161             $('#repoconfig').slideUp();
 162         } else {
 163             $('#vmsetup').slideUp();
 164             $('#repoconfig').slideDown();
 165             if (comp == undefined) {
 166               $('.reposetup').slideUp();
 167             } else {
 168               $('#code').text(createrepourl(rel, mir, comp));
 169               $('.reposetup').slideDown();
 170             }
 171         };
 172      }
 173      else
 174      {
 175         $('#repoconfig').slideUp();
 176         $('#vmsetup').slideUp();
 177      };
 178   };
 179
 180   $(document).ready(function($) {
 181      update_by_form();
 182      $('#repoconfig').hide()
 183      $('.reposetup').hide();
 184      $('#vmsetup').hide()
 185      $('#release').change(update_by_form);
 186      $('#mirror').change(update_by_form);
 187      $('input[name=components]:radio').change(update_by_form);
 188   });
 189
 190   </script>