Skip to content

Commit e156795

Browse files
committed
Fixed documentation
1 parent 4ae56ea commit e156795

File tree

5 files changed

+10
-11
lines changed

5 files changed

+10
-11
lines changed

README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1-
![QMC=Chem logo](https://github.com/trex-coe/qmcchem2/raw/master/docs/QmcChemLogo.png)
1+
![QMC=Chem logo](https://github.com/trex-coe/qmcchem2/raw/master/docs/source/_static/QmcChemLogo.png)
22

33
This repository contains version 2 of QMC=Chem.
44
Version 1 is available on [GitLab](https://gitlab.com/scemama/qmcchem).
55
QMC=Chem is a quantum Monte Carlo program meant to be used after
66
preparing a trial wave function with the
77
[Quantum Package](https://github.com/quantumpackage/qp2) code.
88

9+
The documentation is available on [ReadTheDocs](https://qmcchem2.readthedocs.io/en/latest/index.html).
910

1011
Requirements
1112
------------

docs/source/faq.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ while working with QMC=Chem, along with solutions and advice for each scenario.
4040

4141
**Solution**: If I/O is a bottleneck, consider increasing the block time so that computing a block takes at least twice as long as communicating results. This adjustment can help balance computation and I/O operations, improving overall efficiency.
4242

43-
5. **Slow `qmcchem result` Command**
43+
5. **Slow ``qmcchem result`` Command**
4444

4545
**Issue**: The ``qmcchem result`` command takes a long time to execute.
4646

docs/source/index.rst

-2
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,3 @@ in computational chemistry simulations.
2929
refs
3030

3131

32-
33-
#

docs/source/installation.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -50,19 +50,19 @@ To compile QMC=Chem, execute the following commands:
5050
./autogen.sh
5151
./configure && make
5252
53-
After compilation, it's necessary to set up the environment for QMC=Chem. The environment variables are specified in the `qmcchemrc` file:
53+
After compilation, it's necessary to set up the environment for QMC=Chem. The environment variables are specified in the ``qmcchemrc`` file:
5454

5555
.. code-block:: bash
5656
5757
source qmcchemrc
5858
59-
Set the `QMCCHEM_NIC` environment variable to the appropriate network interface, typically `ib0` on HPC systems.
60-
If needed, set `QMCCHEM_IO=b` to store the results in binary format to accelerate post-processing.
59+
Set the ``QMCCHEM_NIC`` environment variable to the appropriate network interface, typically ``ib0`` on HPC systems.
60+
If needed, set ``QMCCHEM_IO=b`` to store the results in binary format to accelerate post-processing.
6161

6262
Tuning for HPC Systems
6363
----------------------
6464

65-
For optimal performance, the Intel compiler is recommended. If using gfortran version 12 or higher, add the `-fallow-argument-mismatch` option.
65+
For optimal performance, the Intel compiler is recommended. If using gfortran version 12 or higher, add the ``-fallow-argument-mismatch`` option.
6666

6767
Example configurations:
6868

@@ -81,7 +81,7 @@ Example configurations:
8181
File Preparation
8282
----------------
8383

84-
To prepare files for QMC=Chem, the `save_for_qmcchem` plugin must be installed in Quantum Package:
84+
To prepare files for QMC=Chem, the ``save_for_qmcchem`` plugin must be installed in Quantum Package:
8585

8686
.. code-block:: bash
8787

docs/source/usage.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Preparing the System with Quantum Package
1313

1414
1. **Create the EZFIO Database**
1515

16-
Begin by creating an `xyz` file with the nuclear coordinates of the system. For a water molecule:
16+
Begin by creating an ``xyz`` file with the nuclear coordinates of the system. For a water molecule:
1717

1818
.. code-block:: bash
1919
@@ -63,7 +63,7 @@ Performing FN-DMC Calculation with QMC=Chem
6363
6464
2. **Understanding the ``qmcchem`` Command**
6565
66-
The `qmcchem` command is central to operations in QMC=Chem. Running it without arguments displays a help message:
66+
The ``qmcchem`` command is central to operations in QMC=Chem. Running it without arguments displays a help message:
6767
6868
.. code-block:: none
6969

0 commit comments

Comments
 (0)