diff --git a/docs/source/install.rst b/docs/source/install.rst index ecdfb76..fc91597 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -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 diff --git a/docs/source/install/download.rst b/docs/source/install/download.rst index b5d7a24..2e670a7 100644 --- a/docs/source/install/download.rst +++ b/docs/source/install/download.rst @@ -1,29 +1,10 @@ Download ======== -Quantum ESPRESSO ----------------- +You can download executables from here: +| +* 'Windows '_ +* 'Mac OSX '_ -Quantum ESPRESSO is able to be downloaded form `here `_ . - -.. 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 `_ . - -.. 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. diff --git a/docs/source/install/option.rst b/docs/source/install/option.rst new file mode 100644 index 0000000..fb462fe --- /dev/null +++ b/docs/source/install/option.rst @@ -0,0 +1,9 @@ +Quantum ESPRESSO (optionally) +============================= + +Although BURAI contains executables of Quantum ESPRESSO, +| +it is allowed to install other executables optionally `from here `_. + +... note:: + However, the other executalbes are not recommened. \ No newline at end of file diff --git a/docs/source/install/setting.rst b/docs/source/install/setting.rst index 0b7b9d7..71238c7 100644 --- a/docs/source/install/setting.rst +++ b/docs/source/install/setting.rst @@ -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 `_, if your computer does not have it.