Difference between revisions of "Download"

From The Yambo Project
Jump to navigation Jump to search
 
(11 intermediate revisions by 4 users not shown)
Line 1: Line 1:
The Yambo source can be downloaded from the [https://github.com/yambo-code Git-Hub] hosting service. <br>
== Get in touch with Yambo on git (optional) ==
Either a full access to the git repository or tar-balls are available. No registration and/or password is required. <br>
The Yambo source is hosted on the [https://github.com/yambo-code Git-Hub] hosting service. <br>
Nevertheless we warmly invite all Yambo users to register to Github:
Full access to the git repository or tar-balls are available.  
* if you like the project go to the [https://github.com/yambo-code/yambo Yambo repository] and push the star bottom.
No registration or password is required.   <br>
* if you would like to receive updates push the watch bottom as well.
However We warmly invite all Yambo users to register on Github and, after that:
* 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.
* 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.
 
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:
* [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.


== Getting the latest snapshot with git ==
== Getting the latest snapshot with git ==
You need to have git installed on your machine to download the Yambo source.  
To obtain the latest source you need to have <code>git</code> 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.
[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.
For more information, see [https://git-scm.com/ here].


To obtain the last GPL source, you simply need to do:
To obtain the last GPL source, you simply need to do:
Line 18: Line 28:
To see the list of releases just do  
To see the list of releases just do  


  cd yambo
   git branch -a
   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
   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).
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
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 tag
Line 29: Line 55:
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).
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 ==
== Getting the latest snapshot with subversion (obsolete) ==
If you are more familiar with subversion you can also download the whole repository in svn form.
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:
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
<pre>svn checkout https://github.com/yambo-code/yambo.git/branches/4.1 yambo-4.1</pre>
or
or
  svn checkout https://github.com/yambo-code/yambo.git/tags/4.1.2 yambo-4.1.2
<pre>svn checkout https://github.com/yambo-code/yambo.git/tags/4.1.2 yambo-4.1.2</pre>
 
== 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 [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 and we will be glad to set up a specific branch for your needs.


== Direct download of the tar-balls ==
== Starting you own project via a yambo fork ==
Tar-balls are available on the download page:
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.
* [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 us an e-mail.

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.