sphinx/index.rst

   1 .. _WELCOme:
   2
   3 *********************************************
   4  The Ultimate Neuroscience Software Platform
   5 *********************************************
   6
   7 NeuroDebian provides a large collection of popular neuroscience research
   8 software for the Debian_ operating system as well as Ubuntu_ and other
   9 derivatives. Popular packages include FSL, Freesurfer, AFNI, PyMVPA and
  10 :ref:`many others <pkglists>`. While we do strive to maintain a high level of
  11 quality, we make no guarantee that a given package works as expected, so use
  12 them at your own risk. If you do encounter problems or would just like to thank
  13 us, simply `send us an email <#contacts>`_.
  14
  15 Learn more about NeuroDebian, the goals of this project, and help us |spread|!
  16
  17   Halchenko, Y. O. & Hanke, M. (2012). `Open is not enough. Let’s take the
  18   next step: An integrated, community-driven computing platform for neuroscience
  19   <http://www.frontiersin.org/Neuroinformatics/10.3389/fninf.2012.00022/full>`_.
  20   *Frontiers in Neuroinformatics*, 6:22.
  21
  22 .. raw:: html
  23
  24   <div class="linkmore"><a href="/publications.html">more publications</a></div>
  25   <div class="clearer"></div>
  26   <!-- for dynamic quote update via javascript -->
  27   <hr />
  28   <div id="randomquote" title="Feedback from the community">
  29
  30 .. quotes::
  31    :random: 1
  32
  33 .. raw:: html
  34
  35   </div><!-- randomquote -->
  36   <div class="linkmore"><a href="/testimonials.html">more testimonials</a></div>
  37
  38 .. _Ubuntu: http://www.ubuntu.com
  39
  40 .. _repository_howto:
  41 .. _chap_installation:
  42
  43 Get NeuroDebian
  44 ===============
  45
  46 First select what kind of operating system you are using, and then choose a
  47 download server close to you:
  48
  49 .. include:: sources_lists
  50
  51 .. raw:: html
  52
  53   <div class="nojavascriptinstructions">
  54   This form requires javascript. If disabled, incomplete instructions are
  55   displayed below</div>
  56   <div id="reposetup">
  57   <div class="nojavascriptinstructions">
  58   Instructions for Debian-derived systems
  59   </div>
  60
  61 You can enable NeuroDebian on your system by simply copying and pasting the
  62 following two commands into a terminal window. This will add the NeuroDebian
  63 repository to your native package management system, and you will be able to
  64 install neuroscience software the same way as any other package.
  65
  66 .. raw:: html
  67
  68   <pre id="code">
  69   After selecting a release the setup code will be shown here.
  70   </pre>
  71
  72 Now you can update the package index and you are ready to install packages.
  73 Of course you can use your favorite package manager (e.g. synaptic, adept)
  74 for this. In the terminal you can use :command:`apt-get`::
  75
  76   sudo apt-get update
  77   sudo apt-get install mricron
  78
  79 You are ready to go -- enjoy NeuroDebian!
  80
  81 .. note::
  82
  83   Not every package is available for all distributions/releases. For information
  84   about which package version is available for which release and architecture,
  85   please have a look at the corresponding package pages.
  86
  87 .. raw:: html
  88
  89   </div> <!-- end reposetup -->
  90
  91   <div id="vmsetup">
  92   <div class="nojavascriptinstructions">
  93   Instructions for non-Debian systems
  94   </div>
  95
  96 For all non-Debian operating systems we recommend to deploy NeuroDebian as a
  97 `virtual appliance`_ (virtual machine). On all modern hardware (built within
  98 the last 3-4 years) a virtual appliance is a convenient solution to run
  99 NeuroDebian simultaneously with the primary operating system -- without
 100 noticeable performance loss. To start using NeuroDebian:
 101
 102 1. Download this image file:
 103
 104 .. raw:: html
 105
 106   <div id="vmimagedownload">
 107   <a href="http://neuro.debian.net/debian/vm/">NeuroDebian images</a>
 108   </div>
 109
 110 2. Import this image into VirtualBox_. If you do not have VirtualBox_
 111    installed yet, visit the `VirtualBox download page
 112    <http://www.virtualbox.org/wiki/Downloads>`_ and get an installer for your
 113    system (installers for Windows, Linux, Mac and Solaris are available).
 114
 115 3. Finish the configuration by following :ref:`the instructions on setting up
 116    the virtual appliance <chap_vm>`.
 117
 118 You are ready to go -- enjoy NeuroDebian!
 119
 120 .. note::
 121
 122   If you still running an older VirtualBox 3.x, download one of the image files
 123   listed below. These older releases are distributed as a `zip` file. Please
 124   extract all files from the `.zip` file, using appropriate software
 125   for your operating system.
 126
 127   * `NeuroDebian 6.0.2 image (32bit)
 128     <http://neuro.debian.net/debian/vm/neurodebian_6.0.2_i386.zip>`_ [~545MB]
 129
 130   * `NeuroDebian 6.0.2 image (64bit)
 131     <http://neuro.debian.net/debian/vm/neurodebian_6.0.2_amd64.zip>`_ [~560MB]
 132
 133 .. raw:: html
 134
 135   </div> <!-- end vmsetup -->
 136
 137 .. _virtual appliance: http://en.wikipedia.org/wiki/Virtual_appliance
 138 .. _VirtualBox: http://www.virtualbox.org
 139
 140 .. _news:
 141
 142 News
 143 ====
 144
 145 .. raw:: html
 146
 147  <script src="_static/jquery.livetwitter.min.js"></script>
 148  <div id="identica_widget"></div>
 149  <script type="text/javascript">
 150  $("#identica_widget").liveTwitter('neurodebian',
 151                                    {service: 'identi.ca',
 152                                     mode: 'user_timeline',
 153                                     limit: 10,
 154                                     rate: 300000});
 155  </script>
 156  <div class="nojavascriptinstructions">
 157  The news widget requires javascript
 158  </div>
 159
 160 .. _identi.ca: http://identi.ca/neurodebian
 161 .. _twitter: http://twitter.com/NeuroDebian
 162
 163
 164 .. raw:: html
 165
 166   <hr />
 167   <div id="sitemap">
 168
 169 * **About**
 170 * :ref:`Team <chap_team>`
 171 * :ref:`chap_popularity`
 172 * :ref:`FAQ <faq>`
 173 * :ref:`Blog <blog>`
 174 * :ref:`chap_publications`
 175 * :ref:`testimonials`
 176 * :ref:`coffeeart`
 177
 178 .. start a new list
 179
 180 * **Services**
 181 * :ref:`Software <pkglists>`
 182 * :ref:`Data <pkgs-by_purpose-neuroscience_datasets>`
 183 * :ref:`Appliance <chap_vm>`
 184
 185 .. start a new list
 186
 187 * **Community**
 188 * :ref:`Mailing lists <chap_mailinglists>`
 189 * `OpenHatch <https://openhatch.org/+projects/NeuroDebian>`_
 190 * `Identi.ca <http://identi.ca/neurodebian>`_
 191 * `Twitter <http://twitter.com/NeuroDebian>`_
 192 * `Google+ <https://plus.google.com/104292290917252528951>`_
 193 * `YouTube <http://www.youtube.com/neurodebian>`_
 194 * `GitHub <https://github.com/neurodebian>`_
 195
 196 .. start a new list
 197
 198 * **Related**
 199 * `Debian <http://www.debian.org>`_
 200 * `Debian Med <http://www.debian.org/devel/debian-med>`_
 201 * `INCF <http://software.incf.org/software/neurodebian>`_
 202 * `NITRC <http://www.nitrc.org/projects/neurodebian>`_
 203
 204 .. raw:: html
 205
 206   </div><div class="clearer"></div>
 207   <hr />
 208
 209
 210 .. toctree::
 211    :hidden:
 212
 213    blog/index
 214    faq
 215    pkgs
 216    spread
 217    vm
 218    publications
 219    coffeeart
 220    photoalbum
 221    projects
 222    testimonials
 223    testimonials-topics
 224
 225 .. probably should be purged altogether
 226 .. toctree::
 227    :hidden:
 228
 229    booth_sfn2010
 230    datasets
 231    livecd
 232    quotes-nihr01
 233    quotes-nitrc
 234    sources_lists
 235    vm_welcome
 236    dump
 237
 238 .. include:: link_names.txt
 239 .. include:: substitutions.txt
 240
 241 .. raw:: html
 242
 243   <script type="text/javascript">
 244   $(document).ready(function($) {
 245     //setInterval(function(){
 246       $.get('testimonials.html', function(data) {
 247           var quotes = $("blockquote", data);
 248           var idx = Math.floor(quotes.length * Math.random());
 249           $('#randomquote').html(quotes[idx]);
 250       }); // update callback
 251     //}, 60000); // set interval
 252   }); // doc ready
 253   //$("h1").html("NeuroDebian <span style=\"font-size:14px\">&mdash; the ultimate neuroscience software platform</span>")
 254
 255   function foldbuttontoggle(foldname) {
 256       var foldid = '#' + foldname;
 257       var buttonid = foldid + 'button';
 258       $(buttonid).on('click', function() {
 259         $('#' + foldname).slideToggle();
 260         if ($(buttonid).html() == "↓↓↓") {
 261           $(buttonid).html("&uarr;&uarr;&uarr;");
 262         }
 263         else {
 264           $(buttonid).html("&darr;&darr;&darr;");
 265         }
 266       });
 267       $(foldid).slideUp();
 268       $(buttonid).html("&darr;&darr;&darr;");
 269   };
 270
 271   function createvmdownload(rel, mir) {
 272         var img_version = '6.0.5';
 273         var img_suffix;
 274         var base_url;
 275         var img_url;
 276         var md5sum_url;
 277         if (rel == 'win32') {
 278             img_suffix = 'i386';
 279         } else {
 280             img_suffix = 'amd64';
 281         };
 282         if(mir in mirrors) {
 283             base_url = mirrors[mir] + '/vm/';
 284             img_url = base_url + 'NeuroDebian_' + img_version + '_' + img_suffix + '.ova';
 285             md5sum_url = base_url + 'MD5SUMS';
 286         } else {
 287             return 'Internal error';
 288         };
 289         return '<blockquote><a href="' + img_url
 290                + '">Virtual applicance image</a> [<a title="Verify image integrity by dowloading this file and running `md5sum -c MD5SUMS`" href="'
 291                + md5sum_url
 292                + '">MD5SUM</a>, <a title="Verify authenticity of the MD5SUM file by downloading this file and running `gpg –verify MD5SUMS.gpg`" href="'
 293                + md5sum_url + '.gpg">MD5SUM.gpg</a>]</blockquote>' ;
 294
 295   };
 296
 297   function createrepourl(rel, mir) {
 298     if(rel in rel2name && mir in mirrors) {
 299
 300         var retrepo = "wget -O- http://neuro.debian.net/lists/" + rel2name[rel] + "."
 301          + mir + " | sudo tee /etc/apt/sources.list.d/neurodebian.sources.list\n"
 302          + "sudo apt-key adv --recv-keys --keyserver pgp.mit.edu 2649A5A9\n";
 303         return retrepo;
 304     }
 305
 306   };
 307   function updateout(rel, mir) {
 308      if (rel != '' && mir != '') {
 309         if (rel in {'win32':'', 'win64':'', 'mac':''}) {
 310             $('#vmimagedownload').html(createvmdownload(rel, mir));
 311             $('#vmsetup').slideDown();
 312             $('#reposetup').slideUp();
 313         } else {
 314             $('#code').text(createrepourl(rel, mir));
 315             $('#reposetup').slideDown();
 316             $('#vmsetup').slideUp();
 317         };
 318      }
 319      else
 320      {
 321         $('#reposetup').slideUp();
 322         $('#vmsetup').slideUp();
 323      };
 324   };
 325    $('#release').change(function() {
 326      var singleValues = $("#release").val();
 327      var mirrorVal = $("#mirror").val();
 328      updateout(singleValues, mirrorVal);
 329    });
 330    $('#mirror').change(function() {
 331      var singleValues = $("#release").val();
 332      var mirrorVal = $("#mirror").val();
 333      updateout(singleValues, mirrorVal);
 334    });
 335
 336   $(document).ready(function($) {
 337      updateout($("#release").val(), $("#mirror").val());
 338   });
 339
 340   $('#reposetup').hide()
 341   $('#vmsetup').hide()
 342   </script>