Download: Difference between revisions

From The Yambo Project
Jump to navigation Jump to search
No edit summary
No edit summary
 
(16 intermediate revisions by 4 users not shown)
Line 1: Line 1:
== Get in touch with Yambo on git (optional) ==
The Yambo source is hosted on the [https://github.com/yambo-code Git-Hub] hosting service. <br>
Full access to the git repository or tar-balls are available.
No registration or password is required.  <br>
However We warmly invite all Yambo users to register on Github and, after that:
* if you like the project, go to the [https://github.com/yambo-code/yambo Yambo repository] and push the star button.
* if you would like to receive updates push the watch button.
* if you wish, send your github username to the yambo email address and we will add you to the Users group of the yambo project.


The Yambo source can be downloaded from the [http://www.qe-forge.org/ QE-Forge] portal. <br>
Also if you need any further help regarding the access to the Yambo download page please send us an e-mail.
Either a full access to the SVN repository or tar-balls and patches are available.
email: yambo at DOMAIN. DOMAIN=yambo-code.eu


== Getting the latest snapshot with subversion ==
== Direct download (for impatient) ==
Tar-balls are available on the github download page:
* [https://github.com/yambo-code/yambo/wiki/Releases-%28tar.gz-format%29 Browse all releases (tar.gz format)]
* [https://github.com/yambo-code/yambo/wiki/Releases-%28zip-format%29 Browse all releases (zip format)]
Please choose your preferred release.


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>
== Getting the latest snapshot with git ==
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.
To obtain the latest source you need to have <code>git</code> installed.
[https://git-scm.com/ 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.


You need to have subversion (executable svn) installed on your machine to download the Yambo source.
To obtain the last GPL source, you simply need to do:


To obtain the GPL source, do this:
  git clone https://github.com/yambo-code/yambo.git yambo
* [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.
* go to the [http://qe-forge.org/gf/project/yambo yambo project] and click on Request to join.
* wait for our approval mail.
* subscribe to the [http://qe-forge.org/gf/project/yambo/mailman/ mailing-lists] to keep you up-to-date.
* 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
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


'''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:
  cd yambo
  git branch -a


   # GPL Version 3.2.2 Revision 616
and you will see (the outcome will depend on which is the latest stable release)
* master
   remotes/origin/3.4
  remotes/origin/4.0
  remotes/origin/4.1
  remotes/origin/4.2
  remotes/origin/4.3
  remotes/origin/4.4
  remotes/origin/4.5
  remotes/origin/5.0
  remotes/origin/5.1


Thus when reporting problems, make sure to quote the internal revision number! <br>
if you want to switch to a specific version, i.e 4.1 do
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.


You can see the last changes to Yambo on: [http://qe-forge.org/pipermail/yambo-commits/ The Yambo-commits Archives]
  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 check out a specific patch-level you can do
  git tag
  git checkout 4.1.2


== Getting a dedicated branch inside the gpl repository (experimental) ==
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).


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 the latest snapshot with subversion (obsolete) ==
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:
<pre>svn checkout https://github.com/yambo-code/yambo.git/branches/4.1 yambo-4.1</pre>
or
<pre>svn checkout https://github.com/yambo-code/yambo.git/tags/4.1.2 yambo-4.1.2</pre>


 
== Starting you own project via a yambo fork ==
== 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.eu/tutorials/developing_yambo/index.php Developing yambo]. Besides that all you need is to create your own fork of the official yambo repository and start coding. In case you are interested to make your own developments available to the community, you just need to create a pull request from your own fork. Doing so you will get in touch with the yambo team, and we will be glad to help you in the integration process.
 
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)]
* 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)]
 
If you need any further help regarding the access to the Yambo download page please send an E-mail to yambo@yambo-code.org

Latest revision as of 10:27, 23 February 2024

Get in touch with Yambo on git (optional)

The Yambo source is hosted on the Git-Hub hosting service.
Full access to the git repository or tar-balls are available. No registration or password is required.
However We warmly invite all Yambo users to register on Github and, after that:

  • if you like the project, go to the Yambo repository and push the star button.
  • if you would like to receive updates push the watch button.
  • if you wish, send your github username to the yambo email address and we will add you to the Users group of the yambo project.

Also if you need any further help regarding the access to the Yambo download page please send us an e-mail. email: yambo at DOMAIN. DOMAIN=yambo-code.eu

Direct download (for impatient)

Tar-balls are available on the github download page:

Please choose your preferred release.

Getting the latest snapshot with git

To obtain the latest source you need to have git installed. 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.

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

  cd yambo
  git branch -a

and you will see (the outcome will depend on which is the latest stable release)

* master
  remotes/origin/3.4
  remotes/origin/4.0
  remotes/origin/4.1
  remotes/origin/4.2
  remotes/origin/4.3
  remotes/origin/4.4
  remotes/origin/4.5
  remotes/origin/5.0
  remotes/origin/5.1

if you want to switch to a specific version, i.e 4.1 do

  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 check out 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 (obsolete)

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

Starting you own project via a yambo fork

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. Besides that all you need is to create your own fork of the official yambo repository and start coding. In case you are interested to make your own developments available to the community, you just need to create a pull request from your own fork. Doing so you will get in touch with the yambo team, and we will be glad to help you in the integration process.