qsimulatR: a quantum simulator for R
Since December 2020, qsimulatR is available on CRAN for download. It can be installed in R via
install.packages("qsimulatR")An introduction to the package in provided in this document.
tmLQCD Software Suite
tmLQCD is a freely available software suite providing a set of tools to be used in lattice QCD simulations. This is mainly a (P)HMC implementation for Wilson and Wilson twisted mass fermions and inverter for different versions of the Dirac operator.
The code is fully parallelised and ships with optimisations for various modern architectures, such as commodity PC clusters and the Blue Gene family.
The code is available via git. So you need git to be installed on your local machine and you can get a local copy by
git clone https://github.com/etmc/tmLQCD.gitor you can download the following tarball.
If you want to become a Contributor
Get an account on www.github.com, fork the etmc/tmLQCD repository. Clone your fork to your local machine for instance with
git clone git@github.com:yourname/tmLQCD.gitand create a new branch git brach branchname. Perform your modifications and push them to your fork of the repository. (you can commit to your local repository in between as much as you want with full control)
A typical session might look as follows
git clone git@github.com:yourname/tmLQCD.gitcd tmLQCD
git branch branchname
git checkout branchname
...do some work...
# adds newly created files to your local repository
# and adds modified files to the commit list
git add [...]
# commits to your local repository only
git commit
... do some more work...
git add [...]
git commit...
# sends work to own fork on github
git push origin branchname
Note that you have to add every modified file before a commit. If you don't the file will not be commited, in contrast to svn!
Before you submit a pull request now to merge your development into the main tmLQCD branch, everyone should try to remove/resolve any conflicts that may have developed. A typical way to do so is as follows
git remote add upstream git@github.com:etmc/tmLQCD.gitgit fetch upstream -v
# merge any conflicts
git merge upstream/master
If you now want to merge this into the main branch, submit a pull request (a button on github.com for the etmc/tmLQCD repository) and don't forget to have a meaningful description of your changes along with it. It will then be pulled into the main branch after some checks.
We ask you to prepare a signed tag for the pull. For this you'll nee a PGP key.
The code is published in Comp. Phys. Comm. 180(2009)2717. A copy of the paper can be obtained from spires: arXiv:0905.3331 [hep-lat]. A description of the algorithm can be found at spires: hep-lat/0506011 We kindly ask to cite these publications in case the code is used to produce a publication.
You will need the USQCD lime library, which you can download.
Fitting code for lattice QCD with
R - The R Project for Statistical Computing
You can dowload the following R-package, which may be usefull for fitting the hadron spectrum and related quantities in lattice QCD.
Download
please download the package from github.
Install
Install it either as root with R CMD INSTALL hadron.tar.gz or as user for instance into $HOME/lib/R with R CMD INSTALL -l $HOME/lib/R hadron.tar.gz
Install from CRAN
hadron is now also available from CRAN. You can install it via install.packages("hadron")
Using it in R
If you installed the package in your own R directory, do not forget to have a line like R_LIBS="~/lib/R:/usr/local/lib/R-contrib" in a file .Renviron in your home directory.
You can now start R as usual and load the library with library(hadron). Try help(rho).
Documentation
The documentation comes with the package, including a list of vignettes with more detailed examples.
Disclaimer
The codes available for download on this page are free software: you can redistribute and/or modify them under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
The codes are distributed in the hope that they will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
A copy of the GNU General Public License can be found at http://www.gnu.org/licenses/.