| Revision | f1fedd42087256dcbcf5f6f2fe69bd94b6290267 (tree) |
|---|---|
| Zeit | 2018-10-18 23:05:24 |
| Autor |  Mitsuaki Kawamura <kawamitsuaki@gmai...> |
| Commiter | Mitsuaki Kawamura |
Add README
| @@ -0,0 +1,55 @@ | ||
| 1 | +FermiSurfer | |
| 2 | + | |
| 3 | +Web page : http://fermisurfer.osdn.jp/ | |
| 4 | + | |
| 5 | +FermiSurfer is an visualization tool for Fermi surfaces. | |
| 6 | +This application displays Fermi surfaces colored as a function of an arbitrary | |
| 7 | +scalar quantities such as magnitude of Fermi velocities and superconducting gap. | |
| 8 | + | |
| 9 | +# Contents of this package | |
| 10 | + | |
| 11 | + * bin/ : Executable (binary) files for Windows | |
| 12 | + * configure : Script for the installation | |
| 13 | + * src/ : Source code directory | |
| 14 | + * doc/ : Directory for User's manual | |
| 15 | + * doc/index.html : Index of documentation | |
| 16 | + * examples/ : Sample input files (Pb and MgB2) | |
| 17 | + | |
| 18 | +# Installation | |
| 19 | + | |
| 20 | +## Windows | |
| 21 | + | |
| 22 | +We do not need compile programs; | |
| 23 | +Binary file bin/fermisurfer.exe can be used immediately. | |
| 24 | + | |
| 25 | +## Linux/UNIX/macOS | |
| 26 | + | |
| 27 | +Before we install FermiSurfer, we need to install glut or freeglut package | |
| 28 | +with a package installer such as apt, yum, fink, homebrew, macports. | |
| 29 | + | |
| 30 | +Next, we install FermiSurfer into a directory which is included in $PATH as | |
| 31 | + | |
| 32 | +$ ./configure --prefix=**where we install** | |
| 33 | +$ make | |
| 34 | +$ make install | |
| 35 | + | |
| 36 | +# Usage | |
| 37 | + | |
| 38 | +We try to display Fermi surfaces of MgB2 with an input file examples/mgb2_vfz.frmsf | |
| 39 | + | |
| 40 | +## Windows | |
| 41 | + | |
| 42 | +We click the mouse-right-button on the input file. Choose "Open With ..." menu, | |
| 43 | +then choose fermisurfer.exe from the directory tree. | |
| 44 | + | |
| 45 | +## Linux/UNIX/macOS | |
| 46 | + | |
| 47 | +From the terminal | |
| 48 | + | |
| 49 | +$ fermisurfer examples/mgb2_vfz.frmsf | |
| 50 | + | |
| 51 | +# Contact | |
| 52 | + | |
| 53 | +Mitsuaki Kawamura | |
| 54 | + | |
| 55 | +mkawamura__at__issp.u-tokyo.ac.jp |
fermisurfer
Fork
README