Introduction to Monte Python

Size: px

Start display at page:

Download "Introduction to Monte Python"

Madison Brooks
6 years ago
Views:

1 Introduction to Monte Python Benjamin Audren Institute of Theoretical Physics École Polytechnique Fédérale de Lausanne 16/05/2014 BA (EPFL) CLASS/MP Introduction MP 1 / 19

2 Outline 1 git, Github, and why it matters Motivation How to use it? Design Strategy 2 How to contribute 3 Tests BA (EPFL) CLASS/MP Introduction MP 2 / 19

3 Outline 1 git, Github, and why it matters Motivation How to use it? Design Strategy 2 How to contribute 3 Tests BA (EPFL) CLASS/MP Introduction MP 3 / 19

4 Version Control Survey CVS, SVN, git, mercurial? Who uses it daily (weekly? ever?) BA (EPFL) CLASS/MP Introduction MP 4 / 19

5 Version Control Survey CVS, SVN, git, mercurial? Who uses it daily (weekly? ever?) Why bother? Any (complex enough) code has bugs. We are in science, how do we deal with it? BA (EPFL) CLASS/MP Introduction MP 4 / 19

6 Version Control Survey CVS, SVN, git, mercurial? Who uses it daily (weekly? ever?) Why bother? Any (complex enough) code has bugs. We are in science, how do we deal with it? Solution open-source, documented, version-controlled software BA (EPFL) CLASS/MP Introduction MP 4 / 19

7 Motivation Motivation What is Version Control? System that keeps tracks of different versions of a code (several file), tracking its entire history of creation. Accessible from a central repository, that stores all the versions, and allow communication between developers. Can revert to a previous version to reproduce exactly the behaviour at a certain time (bug hunting) BA (EPFL) CLASS/MP Introduction MP 5 / 19

8 Motivation Why does it matter? Version Control in general Pros Hard-drive failure safe Programmer s stupidity safe Bug-hunting made easier Collaborating Robustness BA (EPFL) CLASS/MP Introduction MP 6 / 19

9 Motivation Why does it matter? Version Control in general Pros Hard-drive failure safe Cons Programmer s stupidity safe Bug-hunting made easier Collaborating Robustness getting use to (g)it... BA (EPFL) CLASS/MP Introduction MP 6 / 19

10 Motivation Softwares Version Control Softwares CVS (Concurrent Versions System) Apache Subversion (SVN) Git BA (EPFL) CLASS/MP Introduction MP 7 / 19

11 Motivation Softwares Version Control Softwares CVS (Concurrent Versions System) Apache Subversion (SVN) Git BA (EPFL) CLASS/MP Introduction MP 7 / 19

12 Motivation Github class and Monte Python Code hosted on Github nice code browsing diff and downloads of old versions easy integration of contributions (forks) Wiki complementing the documentation Issues ( forum, suggestions) BA (EPFL) CLASS/MP Introduction MP 8 / 19

13 How to use it? How to use it? Without too much effort? Install git on your machine Debian-based: sudo apt-get install git Mac OS X: sudo port install git-core +svn +doc Windows: BA (EPFL) CLASS/MP Introduction MP 9 / 19

14 How to use it? How to use it? Without too much effort? Install git on your machine Debian-based: sudo apt-get install git Mac OS X: sudo port install git-core +svn +doc Windows: Install CLASS and Monte Python via git... cd codes/ git clone class git clone montepython BA (EPFL) CLASS/MP Introduction MP 9 / 19

15 Design Strategy Design Strategy for both CLASS and Monte Python v1.0 v1.1 v1.2 master devel feature BA (EPFL) CLASS/MP Introduction MP 10 / 19

16 Design Strategy Design Strategy for both CLASS and Monte Python with words Master branch (public and private) and devel branch(es) BA (EPFL) CLASS/MP Introduction MP 11 / 19

17 Design Strategy Design Strategy for both CLASS and Monte Python with words Master branch (public and private) and devel branch(es) master will - should - contain only stable releases, that you can roll back to in case. Between two versions, there will be a new feature. BA (EPFL) CLASS/MP Introduction MP 11 / 19

18 Design Strategy Design Strategy for both CLASS and Monte Python with words Master branch (public and private) and devel branch(es) master will - should - contain only stable releases, that you can roll back to in case. Between two versions, there will be a new feature. devel is for the day to day work, potentially ugly commits, that end up doing something. BA (EPFL) CLASS/MP Introduction MP 11 / 19

19 Design Strategy Design Strategy for both CLASS and Monte Python with words Master branch (public and private) and devel branch(es) master will - should - contain only stable releases, that you can roll back to in case. Between two versions, there will be a new feature. devel is for the day to day work, potentially ugly commits, that end up doing something. feature branches are for developing big modifications without perturbing day to day work. BA (EPFL) CLASS/MP Introduction MP 11 / 19

20 Design Strategy Using Github Practising with the website go to look at the latest commits, the diff, download version BA (EPFL) CLASS/MP Introduction MP 12 / 19

21 How to contribute Outline 1 git, Github, and why it matters 2 How to contribute 3 Tests BA (EPFL) CLASS/MP Introduction MP 13 / 19

22 How to contribute How to contribute Worflow on Github: fork the repository You now have your own version of class Create a new branch my_awesome_model Modifying and commiting Send us the modification as a Pull-Request wiki/contributing BA (EPFL) CLASS/MP Introduction MP 14 / 19

23 How to contribute How to contribute Worflow on Github: fork the repository You now have your own version of class Create a new branch my_awesome_model Modifying and commiting Send us the modification as a Pull-Request wiki/contributing For instance: BA (EPFL) CLASS/MP Introduction MP 14 / 19

24 How to contribute But Github is not free! True But you do not need it. Have a machine somewhere in your lab with ssh access, always on? Set up your remote repository! It is that easy. BA (EPFL) CLASS/MP Introduction MP 15 / 19

25 How to contribute But Github is not free! True But you do not need it. Have a machine somewhere in your lab with ssh access, always on? Set up your remote repository! It is that easy. How? on the remote machine: git clone github_montepython on your machine: git clone ssh://memyself@remote.mpa.kw.we.de/path/to/montepython montepython that s it BA (EPFL) CLASS/MP Introduction MP 15 / 19

26 Tests Outline 1 git, Github, and why it matters 2 How to contribute 3 Tests BA (EPFL) CLASS/MP Introduction MP 16 / 19

27 Tests For the motivated... BA (EPFL) CLASS/MP Introduction MP 17 / 19

28 Tests For the motivated... Tests! Tests are essential asking class with some combination of parameters might uncover a bug BA (EPFL) CLASS/MP Introduction MP 17 / 19

29 Tests For the motivated... Tests are essential asking class with some combination of parameters might uncover a bug Should we store hundreds of parameters and check at every modification that class still works? BA (EPFL) CLASS/MP Introduction MP 17 / 19

30 Tests For the motivated... Tests are essential asking class with some combination of parameters might uncover a bug Should we store hundreds of parameters and check at every modification that class still works? No! BA (EPFL) CLASS/MP Introduction MP 17 / 19

31 Tests For the motivated... Tests are essential asking class with some combination of parameters might uncover a bug Should we store hundreds of parameters and check at every modification that class still works? No! Automatize away! BA (EPFL) CLASS/MP Introduction MP 17 / 19

32 Tests How does it work? class Principle: using nosetests In the file python/test_class.py Different scenarios tested, each with different outputs, each with different gauge, each w/ or w/o non linear corrections.. BA (EPFL) CLASS/MP Introduction MP 18 / 19

33 Tests How does it work? class Principle: using nosetests In the file python/test_class.py Different scenarios tested, each with different outputs, each with different gauge, each w/ or w/o non linear expand ( itertools. product ( ( LCDM, Mnu, Positive_Omega_k, Negative_Omega_k, Isocurvature_modes, ), ({ output : }, { output : mpk }, { output : tcl }, { output : tcl pcl lcl }, { output : mpk tcl lcl, P_k_max_h / Mpc :10}, { output : ncl scl }, { output : tcl pcl lcl ncl scl }), ({ gauge : newtonian }, { gauge : sync }), ({}, { non linear : halofit }))) def test_wrapper_implementation (self, name, scenario, gauge, nonlinear ): BA (EPFL) CLASS/MP Introduction MP 18 / 19

34 Tests How does it work? Monte Python Way to ensure all the default behaviour check that: the code complains with no param file the param file is read only once the cosmo module has all the needed functions the data is well initialized from param file that MH, CH, NS and IS are working BA (EPFL) CLASS/MP Introduction MP 19 / 19

Introduction to Git and Github Repositories

Introduction to Git and Github Repositories Benjamin Audren École Polytechnique Fédérale de Lausanne 29/10/2014 Benjamin Audren (EPFL) CLASS/MP MP runs 29/10/2014 1 / 16 Version Control survey Survey Who