Initial commitv0.3

1 files changed, 102 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..ffc52d5
--- /dev/null
+++ b/README
@@ -0,0 +1,102 @@
+simplesolv is a program to compute the solution of the Simplified approach to
+the Bose gas.
+
+It is written in julia, and requires the julia interpreter to run.
+
+The code is available in the 'src' directory.
+
+The LaTeX source code for the documentation is located in the 'doc' directory.
+A pdf file is available in the source tarball, as well as at
+  http://ian.jauslin.org/software/simplesolv/simplesolv-doc.pdf
+The documentation basic usage examples, an extensive reference of all commands,
+and detailed descriptions of the numerical algorithms used.
+
+Any questions, concerns, or bug reports should be addressed to Ian Jauslin at
+  ian.jauslin@rutgers.edu
+
+simplesolv was written by Ian Jauslin, and is released under the Apache 2.0
+license. It is based on work done in collaboration with
+  Eric A. Carlen
+  Markus Holzmann
+  Elliott H. Lieb
+published in the following papers:
+  * E.A. Carlen, I. Jauslin, E.H. Lieb - Analysis of a simple equation for the
+    ground state energy of the Bose gas, Pure and Applied Analysis, volume 2,
+    issue 3, pages 659-684, 2020,
+    https://doi.org/10.2140/paa.2020.2.659
+    https://arxiv.org/abs/1912.04987
+    http://ian.jauslin.org/publications/19cjl
+
+  * E.A. Carlen, I. Jauslin, E.H. Lieb - Analysis of a simple equation for the
+    ground state energy of the Bose gas II: Monotonicity, Convexity and
+    Condensate Fraction, to appear in the SIAM Journal on Mathematical Analysis
+    https://arxiv.org/abs/2010.13882
+    http://ian.jauslin.org/publications/20cjl
+
+  * E.A. Carlen, M. Holzmann, I. Jauslin, E.H. Lieb - Simplified approach to
+    the repulsive Bose gas from low to high densities and its numerical
+    accuracy, Physical Review A, volume 103, issue 5, number 053309, 2021
+    https://doi.org/10.1103/PhysRevA.103.053309
+    https://arxiv.org/abs/2011.10869
+    http://ian.jauslin.org/publications/20chjl
+  
+
+
+Dependencies:
+
+  * julia interpreter
+      Jeff Bezanson, Stefan Karpinski, Viral B. Shah, and other contributors: https://github.com/JuliaLang/julia/contributors
+      https://julialang.org/
+      MIT and GNU GPLv2 Licenses
+  * julia packages: 
+      FastGaussQuadrature
+	Alex Townsend
+	https://github.com/JuliaApproximation/FastGaussQuadrature.jl
+	MIT license
+      Polynomials
+	Jameson Nash and others
+	https://github.com/JuliaMath/Polynomials.jl
+	MIT license
+      SpecialFunctions
+	Jeff Bezanson, Stefan Karpinski, Viral B. Shah, and others
+	https://github.com/JuliaMath/SpecialFunctions.jl/
+	MIT License
+
+  to typeset the documentation:
+  * pdftex
+    pdfTeX team, TeX Live Team, Hàn Thế Thành
+    http://tug.org/applications/pdftex/
+    GNU GPL
+  * latex
+    LaTeX3 Project
+    https://www.latex-project.org/
+    LaTeX Project Public License 1.3c
+  * LaTeX packages:
+    color
+      David Carlisle, LaTeX3 Project
+      https://ctan.org/pkg/color
+      LaTeX Project Public License 1.3c
+    marginnote
+      Markus Kohm
+      https://komascript.de/marginnote
+      LaTeX Project Public License 1.3c
+    amsfonts
+      American Mathematical Society
+      http://www.ams.org/tex/amsfonts.html
+      SIL Open Font Licence
+    hyperref
+      Sebastian Rahtz, Heiko Oberdiek, LaTeX3 Project
+      https://github.com/latex3/hyperref
+      LaTeX Project Public License 1.3
+    array
+      LaTeX project, Frank Mittelbach
+      https://ctan.org/pkg/array
+      LaTeX Project Public License 1.3
+    doublestroke
+      Olaf Kummer
+      https://ctan.org/pkg/doublestroke
+      Custom Free license
+  * optionally: GNU Make
+    Richard Stallman, Roland McGrath, Paul Smith
+    https://www.gnu.org/software/make/
+    GNU GPLv3