scnc
/
burai
mirror of https://github.com/BURAI-team/burai.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add setting BURAI

This commit is contained in:
mori 2017-06-11 12:51:38 +09:00
parent 7b1303fdfb
commit 41d4992197
4 changed files with 27 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/install.rst
View File

@ -1,6 +1,9 @@
Install
=======
In the following, it is shown how to install Quantum ESPRESSO and BURAI.
In the following, it is shown how to install BURAI:
to download and set it.
|
Optionally, it may be possible to install Quantum ESPRESSO.
-------------------------------------------------------------------------------------------------
@ -9,4 +12,5 @@ In the following, it is shown how to install Quantum ESPRESSO and BURAI.
install/download
install/setting
install/option

31
docs/source/install/download.rst
View File

@ -1,29 +1,10 @@
Download
========
Quantum ESPRESSO
----------------
You can download executables from here:
|
* 'Windows <https://github.com/BURAI-team/burai/releases/download/ver.1.2/BURAI1.2_Windows.zip> '_
* 'Mac OSX <https://github.com/BURAI-team/burai/releases/download/ver.1.2/BURAI1.2_MacOSX.zip> '_
Quantum ESPRESSO is able to be downloaded form `here <http://www.quantum-espresso.org/>`_ .
.. note::
BURAI platform already contains quantum espresso executable files for Windows and Mac OS.
The detailed explanation is shown in setting. :doc:`./setting`
BURAI
-----
BURAI which is a GUI system of Quantum ESPRESSO is able to be downloaded from `BURAI homepage <http://nisihara.wixsite.com/burai>`_ .
.. csv-table:: Download file list
:header: "Item", "explanation"
:widths: 25, 35
"burai.jar", "jar file of BURAI"
"BURAI1.2_MacOSX.zip", "BURAI executable file for Mac OS"
"BURAI1.2_Windows.zip", "BURAI executable file for Windows OS"
"Source code (zip)", "Compressed source code file. (zip format) "
"Source code (tar.gz)", "Compressed source code file. (tar.gz format) "
After downloading, you unzip the compressed BURAI executable file to any directory on your computer.
... note::
These zip-files contain precompiled executable files of Quantum ESPRESSO.

9
docs/source/install/option.rst Normal file
View File

@ -0,0 +1,9 @@
Quantum ESPRESSO (optionally)
=============================
Although BURAI contains executables of Quantum ESPRESSO,
|
it is allowed to install other executables optionally `from here <http://www.quantum-espresso.org>`_.
... note::
However, the other executalbes are not recommened.

21
docs/source/install/setting.rst
View File

@ -1,18 +1,11 @@
Setting
=======
This page explains how to install Quantum ESPRESSO and BURAI.
Users do not need to install Quantum ESPRESSO, because BURAI system already has the Quantum ESPRESSO executables.
These executables were compiled by BURAI team.
if users want to use other Quantum ESPRESSO version, the users should install it and set the path at QE path menue.
BURAI
-----
After :doc:`downloading <./download.rst>`, you unzip the file to any directory on your computer.
The unzipped directory contains BURAI.exe file. The file boot up the BURAI platform.
.. note::
BURAI platform need JRE1.8 or later version. Therefore, you need to install these before you start BURAI platform.
1. unzip `the downloaded file <./download.rst>`
2. copy it to any directory on your computer e.g.:
|
for Windows, C:¥BURAI1.2_Windows¥
|
for MacOSX, /Applications/BURAI1.2.app
3. install `JRE1.8 or later version <https://java.com/download/>`_, if your computer does not have it.