Download: Difference between revisions

From The Yambo Project
Jump to navigation Jump to search
No edit summary
(Page upgraded to github version)
Line 1: Line 1:


The Yambo source can be downloaded from the [http://www.qe-forge.org/ QE-Forge] portal. <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 SVN repository or tar-balls and patches are available.
Either a full access to the git repository or tar-balls are available.


== Getting the latest snapshot with subversion ==
== Getting the latest snapshot with git ==
 
For those of you who don't know what git is, 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>
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:
 
  PROMPT>git clone https://github.com/yambo-code/yambo.git yambo my_local_copy


For those of you who don't know what Subversion is, Subversion is a version control system that is something like an improved CVS. <br>
No registration and/or password is required. Nevertheless we warmly invite all Yambo users to registed to Github and  whenever possible.
For more information, see [http://subversion.tigris.org/ here]. The subversion book is [http://svnbook.red-bean.com/ online] together with the [http://subversion.tigris.org/faq.html FAQ] page.
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


You need to have subversion (executable svn) installed on your machine to download the Yambo source.
  PROMPT>git branch -a
  PROMPT>git checkout 4.1


To obtain the GPL source, do this:
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).
* [http://qe-forge.org/gf/account/?action=UserAdd Register]. You will get a user-name ( QE-FORGE-USERNAME) and a password (QE-FORGE-PASSWORD) you will use to gain access to the SVN repository.
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
* go to the [http://qe-forge.org/gf/project/yambo yambo project] and click on Request to join.
* wait for our approval mail.
  PROMPT>git tag
* subscribe to the [http://qe-forge.org/gf/project/yambo/mailman/ mailing-lists] to keep you up-to-date.
  PROMPT>git checkout 4.1.2
* install [http://subversion.tigris.org/ svn] on your machine and use the QE-forge username and passwords to download a snapshot of the source


  PROMPT>svn co svn+ssh://QE-FORGE-USERNAME@qeforge.qe-forge.org/svnroot/yambo my_local_copy
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).


'''Note on revision numbering''': Regular users of the Yambo repository will notice that the revision numbering has apparently been reset to 1: this coincides with the creation of a separate Yambo GPL source on QE-forge (see the forum announcement for details). The new repository contains the source files for the first official tarball releases (3.1.2 (r300), 3.2.0 (r315), and 3.2.1 (r448) are present as new revisions 1, 2, and 3), as well as newer commits. However, Yambo still internally makes use of the old revision numbering, as seen in the report files, e.g. new revision 4 outputs:


  # GPL Version 3.2.2 Revision 616
== Getting the latest snapshot with subversion ==


Thus when reporting problems, make sure to quote the internal revision number! <br>
If you are more familiar with subversion you can also download the whole repository in svn form.
In the SVN repository you will find two version of Yambo, a stable one, and a developing one. We advise to use the stable version for production runs.
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 downloand in that case:


You can see the last changes to Yambo on: [http://qe-forge.org/pipermail/yambo-commits/ The Yambo-commits Archives]
  PROMPT>svn co https://github.com/yambo-code/yambo.git/branches/4.1


or


== Getting a dedicated branch inside the gpl repository (experimental) ==
  PROMPT>svn co https://github.com/yambo-code/yambo.git/tags/4.1.2


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 [http://www.yambo-code.org/tutorials/developing_yambo/index.php Developing yambo]. Together with this tutorial we are also setting up specific subversion branches inside the GPL repository. Thus, in case you are interested, please contact the yambo team yambo@yambo-code.org and we will be glad to set up a specific branch for your needs.


== Getting a dedicated branch inside the gpl repository (experimental) ==


== SVN repository ? No thanks, I want the tar-balls ==
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 [http://www.yambo-code.org/tutorials/developing_yambo/index.php 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 yambo@yambo-code.org and we will be glad to set up a specific branch for your needs.


In this case go directly to the [http://qe-forge.org/gf/project/yambo/frs/?action=FrsReleaseBrowse&frs_package_id=40 files section] of the Yambo project page.
No registration and/or password is required. Nevertheless we warmly invite all Yambo users to use the SVN repository whenever possible.


* stable version: yambo v3.4.1-rev61 [http://qe-forge.org/gf/download/frsrelease/184/723/yambo-3.4.1-rev61.tgz (QE-Forge)]
== GIT/SVN repository ? No thanks, I want the tar-balls ==
* devel version: yambo v4.0.2-rev90 [http://qe-forge.org/gf/download/frsrelease/201/870/yambo-4.0.2-rev.90.tar.gz (QE-Forge)]


In this case go directly to the download page:
* [https://github.com/yambo-code/yambo/wiki/Releases-%28tar.gz-format%29 Release (tar.gz format)]
* [https://github.com/yambo-code/yambo/wiki/Releases-%28zip-format%29 Release (zip format)]
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 an E-mail to yambo@yambo-code.org
If you need any further help regarding the access to the Yambo download page please send an E-mail to yambo@yambo-code.org

Revision as of 11:58, 21 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.

Getting the latest snapshot with git

For those of you who don't know what git is, 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.

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:

  PROMPT>git clone https://github.com/yambo-code/yambo.git yambo my_local_copy

No registration and/or password is required. Nevertheless we warmly invite all Yambo users to registed to Github and whenever possible. 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

  PROMPT>git branch -a
  PROMPT>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

  PROMPT>git tag
  PROMPT>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 downloand in that case:

  PROMPT>svn co https://github.com/yambo-code/yambo.git/branches/4.1

or

  PROMPT>svn co https://github.com/yambo-code/yambo.git/tags/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 yambo@yambo-code.org and we will be glad to set up a specific branch for your needs.


GIT/SVN repository ? No thanks, I want the tar-balls

In this case go directly to 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 an E-mail to yambo@yambo-code.org