| 1 |
|
| 2 |
============================================================================== |
| 3 |
* * * README file for PWgui * * * |
| 4 |
============================================================================== |
| 5 |
|
| 6 |
This is the PWgui---a GUI for the PWscf set of programs within the |
| 7 |
open-source Quantum ESPRESSO suite for quantum simulation of materials |
| 8 |
(see http://www.quantum-espresso.org). PWgui is written in [incr |
| 9 |
Tcl]---an extension of Tcl scripting language (hence no compilation is |
| 10 |
needed for the PWgui source package). However the package depends on |
| 11 |
the [incr Tcl] and related software. Therefore you have two |
| 12 |
possibilities: |
| 13 |
|
| 14 |
(i) to use a standalone executable which run out of the box. Works |
| 15 |
only on the platforms for which executable has been built. Currently |
| 16 |
the following platforms are supported: Linux, Windows, Mac. |
| 17 |
|
| 18 |
(ii) to use source package if required Tcl software is installed |
| 19 |
(see SOFTWARE REQUIREMENTS section below) |
| 20 |
|
| 21 |
See the file "INSTALL" for installation instructions. |
| 22 |
|
| 23 |
|
| 24 |
CURRENT STATUS |
| 25 |
-------------- |
| 26 |
|
| 27 |
The main purpose of the PWgui is to facilitate the creation and |
| 28 |
manipulation (editing) of input files for PWscf set of programs. It is |
| 29 |
possible to run the PWscf programs by using the GUI. This feature |
| 30 |
requires to set the path of the PWscf executables via |
| 31 |
"File-->Settings" menu (tab: PWscf settings). The GUI can also use the |
| 32 |
XCRYSDEN program (http://www.xcrysden.org/) for the visualization of |
| 33 |
atomic structures from the pw.x input/output files, or for the |
| 34 |
visualization of properties calculated via the sequence: pw.x-->pp.x |
| 35 |
(when the property was saved into an XSF file). |
| 36 |
|
| 37 |
Currently, the following PWscf programs (modules) are supported: |
| 38 |
|
| 39 |
* pw.x |
| 40 |
* neb.x's neb.dat |
| 41 |
* ph.x |
| 42 |
* pp.x |
| 43 |
* projwfc.x |
| 44 |
* bands.x |
| 45 |
* dos.x |
| 46 |
* ld1.x (atomic) |
| 47 |
* hp.x |
| 48 |
|
| 49 |
Directory structure of the PWgui source package: |
| 50 |
|
| 51 |
src/ main source directory of the PWgui |
| 52 |
modules/ GUIB definition files for PWscf programs (modules) |
| 53 |
lib/ libraries used by the PWgui |
| 54 |
images/ icons and images |
| 55 |
examples/ PWscf example input files |
| 56 |
doc/ documentation |
| 57 |
|
| 58 |
|
| 59 |
|
| 60 |
COPYING |
| 61 |
------- |
| 62 |
|
| 63 |
The PWgui is covered by the GNU General Public License. Note that the |
| 64 |
PWgui uses also some external Tcl software, which is covered by |
| 65 |
modified BSD-like free software licenses. |
| 66 |
|
| 67 |
The material included in the directory external/ is the Tcl-related |
| 68 |
software. For the corresponding license see the file |
| 69 |
external/lib/copyright. |
| 70 |
|
| 71 |
All the material included in this distribution is free software; you |
| 72 |
can redistribute it and/or modify it under the terms of the GNU |
| 73 |
General Public License as published by the Free Software Foundation; |
| 74 |
either version 2 of the License, or (at your option) any later |
| 75 |
version. |
| 76 |
|
| 77 |
These programs are distributed in the hope that they will be useful, but |
| 78 |
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY |
| 79 |
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 80 |
for more details. |
| 81 |
|
| 82 |
You should have received a copy of the GNU General Public License along |
| 83 |
with this program; if not, write to the Free Software Foundation, Inc., |
| 84 |
675 Mass Ave, Cambridge, MA 02139, USA. |
| 85 |
|
| 86 |
|
| 87 |
|
| 88 |
NOTE ABOUT THE STANDALONE EXECUTABLES |
| 89 |
------------------------------------- |
| 90 |
|
| 91 |
Standalone executables are build using the Starkit's SDX |
| 92 |
utility. These executables are starkits---a STAandalone Runtime |
| 93 |
tclKITs (http://www.equi4.com/starkit.html). The Tclkit license is the |
| 94 |
following: |
| 95 |
|
| 96 |
"Tclkit is a combination of Tcl/Tk, IncrTcl, TclVFS, Zlib, and |
| 97 |
Metakit. Metakit is open source, using an X/MIT-style license. Tcl/Tk, |
| 98 |
IncrTcl, TclVFS, and Zlib have their own, BSD-ish open source |
| 99 |
licenses, so in my understanding this code can be used freely, also |
| 100 |
commercially. |
| 101 |
|
| 102 |
When Tclkit is distributed as part of a commercial package, copyright |
| 103 |
attributions and license terms for the above need to be included in |
| 104 |
the distribution. |
| 105 |
|
| 106 |
A reference to the origin of Tclkit is appreciated but not required." |
| 107 |
|
| 108 |
|
| 109 |
-- |
| 110 |
Anton Kokalj ([email protected]), 29 Nov 2020 |