Skip to content

Pre 0.1 release sprint

mrahim edited this page Feb 5, 2015 · 25 revisions

Focus of the sprint

The goal is to have nilearn 0.1 released by the end of the sprint, say by 6pm. The focus of this sprint will be on cleaning up documentation and fixing remaining blocking issues.

Having said that, nobody will get in the way of intrinsic motivation, so feel free to work on whatever tickles your fancy on this particular day.

Issues have been tagged to help prioritising:

Place and time

The sprint will happen at the Inria Alan Turing building (Grace Hopper room) and will last the whole day (standard working hours). Directions to the building can be found here.

Pre sprint setup

Follow the instructions there to install all the dependencies, namely numpy, scipy, scikit-learn and matplotlib, if needed.

Please complain loudly if the instructions are not clear enough, improving them could be your first contribution to the sprint!

In order to contribute to nilearn, you need to fork the nilearn project going there.

Clone your own github fork and add the original nilearn repo as a remote

git clone https://github.com/your_github_user_name/nilearn.git
cd nilearn
git remote add upstream https://github.com/nilearn/nilearn

Tests can be run from your nilearn repo:

nosetests -s nilearn

In case you need to generate the documentation:

cd /path/to/your/nilearn/repo
cd doc
make html

This will run the examples which can take a while (~10-20 minutes if you have already downloaded all the datasets and everything has been already cached with joblib, a bit more if nothing is cached and a lot lot more if you need to download some of the biggest datasets).

If your changes to the documentation doesn't involve running the examples, you can get away with make html-noplot which should be a lot quicker.

You can then browse the generated documenation doing something like:

your_favourite_browser _build/html/index.html

Attendants

Please add your name below, if you are planning to attend. Also feel free to mention if you have something in mind you want to work on during the sprint:

  • Loïc Estève (whole day)

  • Gaël Varoquaux (whole day)

  • Mehdi Rahim (whole day) #389 #368

  • Yannick Schwartz (whole day) -> PR on Decoder

  • Alexandre Abraham (whole day) #30 #337 #386

  • Michael Eickenberg (morning) solve matplotlib 1.4.2 colorbar problem, ImageCropper

  • Andrés Hoyos (whole day)

  • Óscar Nájera (whole day) sphinx-gallery integration

  • Danilo Bzdok (whole day) debug FastICA versus CanICA on HCP rest data?

  • Bertrand Thirion (morning) -> any issue for 0.1

  • Salma Bougacha (morning/whole day)

  • elvis dohmatob (whole day): merge PR219 (SpaceNet) !