Difference between revisions of "Download"

From The Yambo Project
Jump to navigation Jump to search
Line 1: Line 1:


The Yambo source can be downloaded from the [https://github.com/yambo-code Git-Hub] hosting service. <br>
The Yambo source can be downloaded from the [https://github.com/yambo-code Git-Hub] hosting service. <br>
Either a full access to the git repository or tar-balls are available.
Either a full access to the git repository or tar-balls are available. No registration and/or password is required.  <br>
Nevertheless we warmly invite all Yambo users to register to Github:
* if you like the project go to the [https://github.com/yambo-code/yambo Yambo repository] and push the star bottom.
* if you would like to receive updates push the watch bottom as well.
* if you wish, send your github username to the [http://mailto:yambo@yambo-code.org yambo@yambo-code.org]. We will add you to the Users group of the yambo project.
 


== Getting the latest snapshot with git ==
== Getting the latest snapshot with git ==


Git is a version control system for tracking changes in computer files and coordinating work on those files among multiple people. It is primarily used for software development. <br>
You need to have git installed on your machine to download the Yambo source.
Git is a version control system for tracking changes in computer files and coordinating work on those files among multiple people. It is primarily used for software development.
For more information, see [https://git-scm.com/ here].
For more information, see [https://git-scm.com/ here].


You need to have git installed on your machine to download the Yambo source.


To obtain the last GPL source, you simply need to do:
To obtain the last GPL source, you simply need to do:
Line 14: Line 19:
   git clone https://github.com/yambo-code/yambo.git yambo
   git clone https://github.com/yambo-code/yambo.git yambo


No registration and/or password is required. Nevertheless we warmly invite all Yambo users to register to Github and  whenever possible.
Please notice that doing so you will download the whole yambo repository, thus included all previous releases.
Please notice that doing so you will download the whole yambo repository, thus included all previous releases.
To see the list of releases just do  
To see the list of releases just do  

Revision as of 14:41, 24 February 2017

The Yambo source can be downloaded from the Git-Hub hosting service.
Either a full access to the git repository or tar-balls are available. No registration and/or password is required.
Nevertheless we warmly invite all Yambo users to register to Github:

  • if you like the project go to the Yambo repository and push the star bottom.
  • if you would like to receive updates push the watch bottom as well.
  • if you wish, send your github username to the yambo@yambo-code.org. We will add you to the Users group of the yambo project.


Getting the latest snapshot with git

You need to have git installed on your machine to download the Yambo source. Git is a version control system for tracking changes in computer files and coordinating work on those files among multiple people. It is primarily used for software development. For more information, see here.


To obtain the last GPL source, you simply need to do:

  git clone https://github.com/yambo-code/yambo.git yambo

Please notice that doing so you will download the whole yambo repository, thus included all previous releases. To see the list of releases just do

  git branch -a
  git checkout 4.1

to switch to a specific version (X.Y) among the ones listed after the command "git branch -a" (X.Y=4.1 in the example). For production we suggest to always checkout a specific branch and not to stay in the master which maybe less stable. The branch corresponding to the version X.Y is always kept at the last patch-level. However if you need to checkout a specific patch-level you can do

  git tag
  git checkout 4.1.2

to switch to a specific release (X.Y.Z) among the ones listed after the command "git tag" (X.Y.Z=4.1.2 in the example).


Getting the latest snapshot with subversion

If you are more familiar with subversion you can also download the whole repository in svn form. Github offers the feature to automatically convert the git repo during the download. However remember that the repository in svn like form will be much bigger (~300 MB) that in git form (16 MB). Thus it is better to directly specify which branch you would like to download in that case:

  svn checkout https://github.com/yambo-code/yambo.git/branches/4.1 yambo-4.1

or

  svn checkout https://github.com/yambo-code/yambo.git/tags/4.1.2 yambo-4.1.2


Getting a dedicated branch inside the gpl repository (experimental)

Yambo is a GPL code mantained by a small team of researchers. If you would like to help us coding new features or simply you would like to modify the code for your needs, we advise to follow the online tutorial Developing yambo. Together with this tutorial we can also give you write permission inside the GPL repository. Thus, in case you are interested, please contact the yambo team and we will be glad to set up a specific branch for your needs.


Direct download of the tar-balls

Tar-balls are available on the download page:

of the Yambo Git-hub project and download the wanted release. If you need any further help regarding the access to the Yambo download page please send us an e-mail.