diff --git a/docs/quick_start/windows_installer.md b/docs/advanced/windows_installer.md similarity index 100% rename from docs/quick_start/windows_installer.md rename to docs/advanced/windows_installer.md diff --git a/docs/index.rst b/docs/index.rst index a5209940347..dd0b5968c4c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,7 +26,6 @@ the developments and applications of novel machine-learning-assisted DFT methods :caption: Quick Start quick_start/easy_install - quick_start/windows_installer quick_start/hands_on quick_start/input quick_start/output @@ -45,6 +44,7 @@ the developments and applications of novel machine-learning-assisted DFT methods advanced/output_files/index advanced/interface/index advanced/input_files/index + advanced/windows_installer .. toctree:: :maxdepth: 2 diff --git a/docs/quick_start/easy_install.md b/docs/quick_start/easy_install.md index 90128a707b1..c9c33096691 100644 --- a/docs/quick_start/easy_install.md +++ b/docs/quick_start/easy_install.md @@ -1,6 +1,6 @@ # Easy Installation -This guide helps you install ABACUS with basic features. **For DeePKS, DeePMD and Libxc support, or building with `make`, please refer to [the advanced installation guide](../advanced/install.md)** after going through this page. We recommend building ABACUS with `cmake` to avoid dependency issues. We recommend compiling ABACUS (and possibly its requirements) from the source code using the latest compiler for the best performace. You can use [toolchain](#install-by-toolchain) to install ABACUS and dependencies in a source-code compilation way with convience. You can also deploy ABACUS **without building** by [Docker](#container-deployment) or [conda](#install-by-conda). Please note that ABACUS only supports Linux; for Windows users, please consider using [WSL](https://learn.microsoft.com/en-us/windows/wsl/) or docker. For a scripted one-click setup that provisions WSL2 and installs ABACUS inside it automatically, see [Windows One-Click Installer](./windows_installer.md). +This guide helps you install ABACUS with basic features. **For DeePKS, DeePMD and Libxc support, or building with `make`, please refer to [the advanced installation guide](../advanced/install.md)** after going through this page. We recommend building ABACUS with `cmake` to avoid dependency issues. We recommend compiling ABACUS (and possibly its requirements) from the source code using the latest compiler for the best performace. You can use [toolchain](#install-by-toolchain) to install ABACUS and dependencies in a source-code compilation way with convience. You can also deploy ABACUS **without building** by [Docker](#container-deployment) or [conda](#install-by-conda). Please note that ABACUS only supports Linux; for Windows users, please consider using [WSL](https://learn.microsoft.com/en-us/windows/wsl/) or docker. For a scripted one-click setup that provisions WSL2 and installs ABACUS inside it automatically, see [Windows One-Click Installer](./advanced/windows_installer.md). ## Get ABACUS source code