Skip to content

Commit

Permalink
docs: updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jabirali committed Sep 29, 2024
1 parent ad04775 commit 4678274
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,8 @@ Research papers where this code has been used include:

Bodge can be used on anything from a normal laptop to an HPC cluster, as long as
it runs an operating system where the SciPy stack is available (e.g. Linux,
MacOS, or Windows). It is mainly meant for CPU-based calculations on one node
(i.e. no MPI support), however some functions on the `development` branch
contains optional support for GPU-based calculations via CuPy (CUDA).
MacOS, or Windows). It is mainly meant for CPU-based or GPU-based calculations
on one computer or node (so there is currently no support for e.g. MPI).

Internally, Bodge uses a sparse matrix (`scipy.sparse`) to represent the Hamiltonian,
which allows you to efficiently construct tight-binding models with millions of
Expand All @@ -43,6 +42,8 @@ this requires you to have installed CUDA support on your system beforehand):

pip install bodge[cuda]

Some functions then accept an argument `cuda=True` to enable GPU support.

Bodge should be quite easy to use if all you want is a real-space lattice
Hamiltonian with superconductivity. For instance, consider a $100a\times100a$
s-wave superconductor with a chemical potential $μ = -3t$, superconducting gap
Expand Down

0 comments on commit 4678274

Please sign in to comment.