mirror of https://gitlab.com/QEF/q-e.git
f63d6d3089
git-svn-id: http://qeforge.qe-forge.org/svn/q-e/trunk/espresso@1758 c92efa57-630b-4861-b058-cf58834340f0 |
||
---|---|---|
.. | ||
doc/pwdocs | ||
examples | ||
external | ||
images | ||
lib | ||
modules | ||
pwgui_vfs | ||
src | ||
sys_utils | ||
tests | ||
AUTHORS | ||
BUGS | ||
COPYING | ||
COPYRIGHT | ||
ChangeLog | ||
INSTALL | ||
INSTALL.cvs | ||
Make.include | ||
Makefile | ||
NEWS | ||
README | ||
README.developer | ||
THANKS | ||
TODO | ||
VERSION | ||
header.tcl | ||
make.usage | ||
pwgui | ||
pwgui.activeTcl | ||
pwgui.bat | ||
pwgui.settings | ||
pwgui.tcl | ||
pwgui_reformat | ||
pwgui_reformat.tcl |
README
============================================================================== * * * README file for PWgui * * * ============================================================================== This is the PWgui---a GUI for the PWscf set of programs (see http://www.pwscf.org/). PWgui is written in [incr Tcl]---an extension of Tcl scripting language. Due to the use of scripting language no compilation is needed for the PWgui. However the package depends on the [incr Tcl] and related software. Therefore you have two possibilities: (i) to use a standalone executable which run out of the box. Works only on the platform fot which it have been built. Currently the following plaforms are supported: Linux, Windows, MacOSX. (ii) to use source package if required Tcl software is installed (see SOFTWARE REQUIREMENTS section below) See the file "INSTALL" for installation instructions. CURRENT STATUS -------------- This version of PWgui is compatible with PWscf 2.1. The main purpose of the PWgui GUI is to facilitate the creation and manipulation (editing) of input files for PWscf set of programs. It is possible to run the PWscf programs by using the GUI. This feature requires to set the path of the PWscf executables via "File-->Settings" menu (tab: PWscf settings). The GUI can also use the XCRYSDEN program (http://www.xcrysden.org/) for the visualization of atomic structures from the pw.x input/output files, or for the visualization of properties calculated via the sequence: pw.x-->pp.x-->chdens.x (when the property was saved into an XSF file). Currently, the following PWscf programs (modules) are supported: * pw.x * ph.x * pp.x * chdens.x * projwfc.x * d3.x Directory structure of the PWgui package (source package): src/ main source directory of the PWgui modules/ GUIB definition files for PWscf programs (modules) lib/ libraries used by the PWgui images/ icons and images examples/ PWscf example input files doc/ documentation bin/ contains the itkwish interpreter (self-contained packages only) external/ external Tcl-related software (self-contained packages only) COPYING ------- The PWgui is covered by the GNU General Public License. Note that the PWgui uses also some external Tcl software, which is covered by modified BSD-like free software licenses. The material included in the directory external/ (self-contained packages only) is the Tcl-related software. For the corresponding license see the file external/lib/copyright. All the material included in this distribution is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. These programs are distributed in the hope that they will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. NOTE ABOUT THE STANDALONE EXECUTABLES ------------------------------------- Standalone executables are build using the Starkit's SDX utility. These executables are starkits---a STAandalone Runtime tclKITs (http://www.equi4.com/starkit.html). The Tclkit license is the following: "Tclkit is a combination of Tcl/Tk, IncrTcl, TclVFS, Zlib, and Metakit. Metakit is open source, using an X/MIT-style license. Tcl/Tk, IncrTcl, TclVFS, and Zlib have their own, BSD-ish open source licenses, so in my understanding this code can be used freely, also commercially. When Tclkit is distributed as part of a commercial package, copyright attributions and license terms for the above need to be included in the distribution. A reference to the origin of Tclkit is appreciated but not required." -- Anton Kokalj (tone.kokalj@ijs.si), Mon Sep 20 08:46:19 CEST 2004