You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -83,21 +79,21 @@ There are two methods how you can set-up all the dependencies before starting th
83
79
.. code-block:: shell
84
80
85
81
$conda config --add channels conda-forge
86
-
$conda create --name cytnx python=3.8 llvm-openmp
82
+
$conda create --name cytnx python=3.9 llvm-openmp
87
83
$conda activate cytnx
88
84
$conda upgrade --all
89
85
90
86
.. Note::
91
87
92
-
1. The python=3.8 indicates the Python version you want to use. Generally, Cytnx is tested with 3.7/3.8/3.9. You can replace this with the version you want to use.
88
+
1. The python=3.9 indicates the Python version you want to use. Generally, Cytnx is tested with 3.9+. You can replace this with the version you want to use.
93
89
2. The last line is updating all the libraries such that they are all dependent on the conda-forge channel.
3. After the installation, an automated test based on gtest and benchmark can be run. This option needs to be activated in the install script. In this case, gtest needs to be installed as well:
113
109
@@ -167,13 +163,22 @@ Compiling process
167
163
-------------------
168
164
Once you installed all the dependencies, it is time to start building the Cytnx source code.
169
165
170
-
**Option A. Compiling with script**
166
+
**Option A. Using cmake preset**
167
+
168
+
We support the ``cmake-presets`` tool for building the library starting from version
169
+
v1.1.0. You can find the configuration file in ``CMakePresets.json``. For example,
170
+
if you choose the ``openblas-cpu`` preset, use the following command to build:
171
171
172
-
Starting from v0.7.6a, Cytnx provides a shell script **Install.sh**, which contains all the cmake arguments as a check list. To install, edit the script, un-comment and modify custom parameters in the corresponding lines. Then, simply execute this script:
173
172
174
173
.. code-block:: shell
175
174
176
-
$sh Install.sh
175
+
$cmake --preset openblas-cpu
176
+
$cmake --build --preset openblas-cpu
177
+
.. note::
178
+
179
+
If you are using Visual Studio Code, you can also take advantage of the
180
+
*CMake Tools* extension, which provides built-in support for selecting and
181
+
running CMake presets directly from the editor.
177
182
178
183
179
184
**Option B. Using cmake install**
@@ -185,7 +190,7 @@ Please see the following steps for the standard cmake compiling process and all
185
190
186
191
.. code-block:: shell
187
192
188
-
$make build
193
+
$mkdir build
189
194
$cd build
190
195
191
196
2. Use cmake to automatically generate compiling files:
@@ -199,7 +204,7 @@ The following are the available compiling option flags that you can specify in *
@@ -290,7 +295,7 @@ In the case that Cytnx is installed locally from binary build, not from anaconda
290
295
291
296
Generate API documentation
292
297
*************************************
293
-
An API documentation can be generated from the source code of Cytnx by using doxygen. The documentation is accessible online at <https://kaihsinwu.gitlab.io/cytnx_api/>. To create it locally, make sure that doxygen is installed:
298
+
An API documentation can be generated from the source code of Cytnx by using doxygen. The documentation is accessible online at `here <../api_build/html/index.html>`__. To create it locally, make sure that doxygen is installed:
0 commit comments