11[ ![ DOI] ( https://zenodo.org/badge/23153/mlxd/GPUE.svg )] ( https://zenodo.org/badge/latestdoi/23153/mlxd/GPUE )
22[ ![ Code Climate] ( https://codeclimate.com/github/mlxd/GPUE/badges/gpa.svg )] ( https://codeclimate.com/github/mlxd/GPUE )
33![ GPUE version] ( https://img.shields.io/badge/v-0.abs(exp(1i*pi))-blue.svg )
4- ###############################################################################
5- ###############################################################################
6-
4+ ---
75[ logo ] : https://github.com/mlxd/GPUE/blob/master/logo.png " GPUE "
86![ GPUE - GPU Gross-Pitaevskii Equation solver] [ logo ]
97
1210[ bb ] : https://bitbucket.org/loriordan/gpue " Bitbucket "
1311[ gh ] : https://github.com/mlxd/gpue " GitHub "
1412
15- ###############################################################################
1613## 0. Introduction
17- ###############################################################################
14+ ---
1815
1916Welcome to GPUE, the [ fastest zero temperature BEC routines in the land] ( http://peterwittek.com/gpe-comparison.html ) (the last time we checked).
2017
@@ -47,9 +44,8 @@ If you enjoy/use/learn from this code, please give me a citation, as it took a
4744long time to develop, and I'd appreciate it greatly! A nice email would suffice
4845too :)
4946
50- ###############################################################################
5147## 1. What does this software do?
52- ###############################################################################
48+ ---
5349
5450This software is a CUDA-enabled non-linear Schrodinger (Gross-Pitaevskii)
5551equation solver. The primary use of this code was for my research on
@@ -84,9 +80,8 @@ a 2D system only. Extensions to 3D are currently in the works, and are in the
8480beta branch lead by the amazing James Schloss (leois). When completed, these
8581will be merged into master.
8682
87- ###############################################################################
8883## 2. Great! How do I make a BEC?
89- ###############################################################################
84+ ---
9085
9186Well, first you need to look at the run_params.conf file, and give it some
9287necessary parameters to generate your favourite condensate.
@@ -101,15 +96,13 @@ The above parameters will be better explained when the papers have been
10196published (which is only fair). Comments will be added for relevant sections
10297too to allow for their use.
10398
104- ###############################################################################
10599## 3. What do you see as the future of this?
106- ###############################################################################
100+ ---
107101I would like this tool to be a suite for 1D, 2D and 3D simulations of both
108102Schrodinger and non-linear Schrodinger systems.
109103
110- ###############################################################################
111104## 4. I have used your program and/or learned from the source. What now?
112- ###############################################################################
105+ ---
113106A citation would be nice :) Feel free to cite as:
114107
115108Lee James O'Riordan et al., GPUE: Phasegineering release, Zenodo. (2016)
@@ -124,9 +117,8 @@ There is a lot remaining to be done, but many hands make light work, after all.
124117
125118
126119
127- ###############################################################################
128120## 5. Acknowledgements
129- ###############################################################################
121+ ---
130122We are greatly thankful to the support provided by Okinawa Institute of Science
131123and Technology Graduate University, without whom this research code would be a
132124fraction of what it currently has become. To the various people who have
0 commit comments