Commit 8346f268 authored by Jefferson Stafusa E. Portela's avatar Jefferson Stafusa E. Portela
Browse files


parent 7254f2d1
## pyALF
The package implements ALF's python interface. `pyALF` greatly simplifies using the code, making it ideal for:
* *obtaining benchmark* results for established models;
* *getting started* with QMC and ALF;
* or just *quickly running* a simulation with ALF.
## Prerequisites
* Python
* Jupyter
* the libraries Lapack and Blas
* a Fortran compiler, such as gfortran or ifort,
where the last two are required by the main package [ALF](
Also, add pyALF's path to your environment variable `PYTHONPATH`. In Linux, this can be achieve, e.g., by adding the following line to `.bashrc`:
export PYTHONPATH="/local/path/to/pyALF:$PYTHONPATH"
## Starting
Jupyter notebooks [are run]( through a Jupyter server started, e.g., from the command line:
jupyter notebook
which opens the "notebook dashboard" in your default browser, where you can navigate through your file structure to the pyALF directory. There you will find the interface's core module, ``, some auxiliary files, and a number of notebooks.
However, pyALF can also be used to start a simulation from the command line, without starting a Jupyter server. For instance:
python3.7 -R --alfdir /home/debian/ALF-1.2/ --config "Intel" --executable_R Hubbard --mpi True &
## Files and directories
* `` - provides interfaces for compilig, running and postprocessing ALF in Python
* `` - defines dictionaries containing all ALF parameters with default values
* `` - helper script for compiling, running and testing ALF
* `Sims` - configuration for running directly from the command line
* `Notebooks` - directory containing Jupyter notebooks
## License
The various works that make up the ALF project are placed under licenses that put
a strong emphasis on the attribution of the original authors and the sharing of the contained knowledge.
To that end we have placed the ALF source code under the GPL version 3 license (see license.GPL and license.additional)
and took the liberty as per GPLv3 section 7 to include additional terms that deal with the attribution
of the original authors(see license.additional).
The Documentation of the ALF project by the ALF contributors is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License (see Documentation/license.CCBYSA)
We mention that we link against parts of lapack which licensed under a BSD license(see license.BSD).
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment