X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=sphinx%2Findex.rst;h=a86de236290e37313d8e910d052e6ae9d76b3cf6;hb=51fda68849a6979be9e369183ac6dbbd4f892459;hp=8bec69dd93129b5fe90d3596de5713186f2b2593;hpb=7b779cdca773a4a6e4091abe4c48db33ab22b49e;p=neurodebian.git diff --git a/sphinx/index.rst b/sphinx/index.rst index 8bec69d..a86de23 100644 --- a/sphinx/index.rst +++ b/sphinx/index.rst @@ -1,26 +1,83 @@ +.. _WELCOme: + *********************************************** Welcome to the Debian Neuroscience Repository *********************************************** +.. quotes:: + :random: 1 + This repository provides mostly neuroscience-related packages to be used on -Debian systems (or Debian-derivatives like Ubuntu). It contains both unofficial -or prospective packages which are not (yet) available from the main Debian -archive, as well backported or simply rebuilt packages also available +Debian_ systems (or Debian-derivatives like Ubuntu_). It contains both unofficial +or prospective packages which are not (yet) available from the main Debian_ +archive, as well as backported or simply rebuilt packages also available elsewhere. Please see the :ref:`faq` for more information about the goals of -this project. +this project, and :ref:`read what people say about it `. +If you appreciate this service, please |spread|. + +.. note:: + + This service is provided "as is". There is no guarantee that a package + works as expected, so use them at your own risk. If you encounter problems, + please `report <#contacts>`_ them. + + +.. raw:: html + +

+ + + + +

+ +.. _Ubuntu: http://www.ubuntu.com + +News +==== + +.. raw:: html -This service is provided "as is". There is no guarantee that a package -works as expected, so use them at your own risk. They might kill your -system (although that is rather unlikely). You've been warned! + + -The repository contains both neuroscience-related packages, as well as general -purpose software which is necessary to resolve dependencies, or such that is -simply useful in the neuroscience context. All featured neuroscience software -packages are available from the :ref:`full package list `. +Follow us on twitter_ to subscribe to the NeuroDebian news. +.. _twitter: http://twitter.com/NeuroDebian .. _repository_howto: + + How to use this repository ========================== @@ -37,14 +94,24 @@ releases and repository mirrors: .. include:: sources_lists .. note:: - Thanks to the `Department of Experimental Psychology at the University of - Magdeburg`_, and the `Department of Psychological and Brain Sciences at Dartmouth - College`_ for hosting a mirror. + Thanks to the following institutions and individuals for hosting a mirror: + + * `Department of Psychological and Brain Sciences at Dartmouth College`_ + *[us-nh]* (primary mirror) + * `Department of Experimental Psychology at the University of Magdeburg`_ + *[de]* + * `Neurobot at Aristotle University of Thessaloniki, Greece`_ *[gr]* + * `Paul Ivanov`_ *[us-ca]* + * `Medical-image Analysis and Statistical Interpretation lab at Vanderbilt`_ + *[us-tn]* If your are interested in mirroring the repository, please see the :ref:`faq`. -.. _Department of Experimental Psychology at the University of Magdeburg: http://apsy.gse.uni-magdeburg.de .. _Department of Psychological and Brain Sciences at Dartmouth College: http://www.dartmouth.edu/~psych +.. _Department of Experimental Psychology at the University of Magdeburg: http://apsy.gse.uni-magdeburg.de +.. _Neurobot at Aristotle University of Thessaloniki, Greece: http://neurobot.bio.auth.gr +.. _Paul Ivanov: http://www.pirsquared.org +.. _Medical-image Analysis and Statistical Interpretation lab at Vanderbilt: https://masi.vuse.vanderbilt.edu Once this is done, you have to update the package index. Use your favorite package manager, e.g. synaptic, adept, or whatever you like. In the terminal @@ -61,34 +128,142 @@ Now, you can proceed to install packages, e.g.:: about which package version is available for which release and architecture, please have a look at the corresponding package pages. +After this initial setup you probably also want to configure your package +manager to recognize the NeuroDebian archive key. With this key the package +manager can verify that packages haven't been modified and are identical with +the ones in the main NeuroDebian archive, regardless of which mirror you +downloaded them from. The NeuroDebian key id is **2649A5A9**. If you need further +help setting up package authentication, please take a look at +:ref:`corresponding FAQ `. + + +.. _chap_installation: + +Ways to use NeuroDebian +======================= + +Virtual machine +--------------- + +If you are not running Debian_ on a particular machine a :ref:`chap_vm` is +provided as a convenient testing and evaluation environment. After a few +simple steps to setup the virtual machine, you will be able to use NeuroDebian_ +as an integral part of your existing working environment without any sacrifice. +The virtual machine is also a suitable environment to temporarily deploy +neuroscience software on machines running other operating systems, e.g. for the +purpose of teaching a neuroimaging data analysis course in a multipurpose +computer lab. + + +Debian installation +------------------- + +Having been exposed to the wonders of NeuroDebian_ you are no longer +satisfied with your previous choice of operating system? We would +recommend installing Debian_ to replace or complement (dual-boot) your +existing OS. Please visit `"Getting Debian" +`_ to obtain the images for your +hardware architecture and then simply add |repos|. + + +.. _chap_team: + + +The team +======== + +Our main goal is to provide neuroscience FOSS_ for Debian_. Thus the +whole project would not be possible without the work of over 3,000 +Debian_ developers and contributors who are as enthusiastically pursuing +a similar goal. To add our share -- Debian_ packages of FOSS_ for +neuroscience research -- the `Experimental Psychology Debian packaging +project `_ was created +to formally join the forces of + +* `Michael Hanke `_ +* `Yaroslav Halchenko `_ + +A number of packages that are now available from the NeuroDebian repository +were not packaged by our team, but similar Debian teams. Therefore we want to +express particular gratitude to the `Debian Med`_ and `Debian Science`_ teams +for all their work. + +.. _FOSS: http://en.wikipedia.org/wiki/Free_and_open_source_software + + +Contacts +======== + +`Email us directly `_ with any "private" +communication. Otherwise please use our public mailing lists, which +exist not only to provide user-support but also to establish +communication channels within the NeuroDebian community + +* neurodebian-users_: Discussions and support of NeuroDebian users + +* neurodebian-upstream_: General discussions and knowledge sharing + among developers of the neuroscience software. We will also use it + to update you with summaries of recent relevant developments in + Debian project + +* neurodebian-devel_: Technical mailing list for discussions on + NeuroDebian development + +.. _neurodebian-users: http://lists.alioth.debian.org/mailman/listinfo/neurodebian-users +.. _neurodebian-devel: http://lists.alioth.debian.org/mailman/listinfo/neurodebian-devel +.. _neurodebian-upstream: http://lists.alioth.debian.org/mailman/listinfo/neurodebian-upstream + + +Acknowledgements +================ + +We are grateful to Jim Haxby for his continued support and :ref:`endless supply of +Italian espresso `. + + +Publications +============ -Package authentication ----------------------- +Halchenko, Y. O., Hanke, M., Haxby, J. V., Pollmann, S. & Raizada, R. D. +(2010). Having trouble getting your Nature paper? Maybe you are not using the +right tools? *Poster to be presented at the anual meeting of the Society for +Neuroscience*, San Diego, USA. -When you start using this repository, you probably get warning messages -like this:: +Hanke, M., Halchenko, Y. O. (2010). `Debian: The ultimate platform for +neuroimaging research <_files/HankeHalchenko_NeuroDebianDebConf10.pdf>`_. +*Talk given at* DebConf10_, New York City, USA. [video: +`low resolution `_, +`high resolution `_] - The following signatures couldn't be verified because - the public key is not available.` +Hanke, M., Halchenko, Y. O., Haxby, J. V. & Pollmann, S. (2010). `Improving +efficiency in cognitive neuroscience research with NeuroDebian +<_files/NeuroDebian_CNS2010.pdf>`_. *Poster presented at the annual +meeting of the Cognitive Neuroscience Society*, Montréal, Canada. -Or you will be asked questions like this over and over:: +.. _DebConf10: http://debconf10.debconf.org/ - WARNING: The following packages cannot be authenticated! - ... - Install these packages without verification [y/N]? -This is because your APT installation initially does not know the GPG -key that is used to sign the release files of this repository. Making -APT happy again is easy: +.. toctree:: + :hidden: -1. Get the key. Either download the `repository key from here - <_static/neuro.debian.net.asc>`_ - or fetch it from http://wwwkeys.pgp.net (2649A5A9). + faq + pkgs + spread + vm + coffeeart + testimonials -2. Now feed the key into APT by invoking:: +.. probably should be purged altogether +.. toctree:: + :hidden: - apt-key add #file# + livecd + gpg + setup + links_names + substitutions + quotes-nihr01 + quotes-nitrc - Where `#file#` has to be replaced with the location of the key file you just - downloaded. You need to have superuser-privileges to do this (either do it - as root or use sudo). +.. include:: links_names.rst +.. include:: substitutions.rst