#Welcome to the Boson Slave-Solver (BoSS) software repository v1.0
For a short description of what this software does in ''layman'' terms, go here.
This software uses a ''slave-boson'' or slave-particle approach to approximately solve for the ground state electronic properties of an interacting electronic system described as an extended Hubbard model. References to consult and cite if you use the software are https://journals.aps.org/prb/abstract/10.1103/PhysRevB.92.235117 and https://journals.aps.org/prb/abstract/10.1103/PhysRevB.96.165135 .
Please cite the above two works if you have used BoSS to publish your work.
To download the software suite with examples and documentation, you can either
Click on "Downloads" on the left bar of this page and then download a copy of the latest and greatest, and/or
To clone the git repository that will allow easy updating and commits, install the git package (if you don't have it already) and then issue the command line
git clone https://bitbucket.org/yalebosscode/boss.git
You will find more thorough documentation and examples once you download. The place to start is the README.pdf file in the "doc" directory. (Clicking on the hyperlink in the previous sentence will show you the file and to download the PDF click on "View raw" which we agree is very unintuitive).
If you have questions, comments, bugs to report, etc., please use the "Issues" method (also found on the leftside menu) to communicate to the developers. This is much better than emailing them since (a) it creates a log of questions and answers that can be searched and viewed by other users, and (b) it leads to a recorded and public log of what needs to be answered so we can keep track and not let your question become forgotten.