Skip to content

Commit c9f0267

Browse files
committed
[doc] update install instructions use triqs/unstable adapol/triqs_xca
1 parent d5d07ca commit c9f0267

1 file changed

Lines changed: 4 additions & 6 deletions

File tree

doc/install.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,17 @@ Install xca
88
Compiling xca from source
99
===============================
1010

11-
.. note:: To guarantee reproducibility in scientific calculations we strongly recommend the use of a stable `release <https://github.com/TRIQS/triqs/releases>`_ of both TRIQS and its applications.
12-
1311
Prerequisites
1412
-------------
1513

1614
#. The :ref:`TRIQS <triqslibs:welcome>` library, see :ref:`TRIQS installation instruction <triqslibs:triqs_install>`.
1715
In the following, we assume that TRIQS is installed in the directory ``path_to_triqs``.
1816

19-
We are currently depending on the `unstable` development version of TRIQS (that will be released as version 4.0 in the end of 2025). However, for a smoother installation experience we provide tested branches with the naming pattern `triqs/DEV_PPSC_*` (as of writing `triqs/DEV_PPSC_20250912`) that trail the `triqs/unstable` branch with fixed versions of all subpackages (e.g. `itertools`, `mpi`, `h5`, `nda`, etc.). Long story short. **Please install TRIQS on the latest `triqs/DEV_PPSC_*` branch.**
20-
21-
#. The `adapol <https://github.com/flatironinstitute/adapol>`_ package (Adaptive Pole Fitting for Quantum Many-Body Physics) has to be installed on the `main` branch. This can be achieved using a local `pip` install, e.g.::
17+
We are currently depending on the `unstable` development branch of TRIQS that has to be compiled from source. (Note that the packaged versions of TRIQS are not supported.)
18+
19+
#. The `adapol <https://github.com/flatironinstitute/adapol>`_ package (Adaptive Pole Fitting for Quantum Many-Body Physics) has to be installed on the `triqs_xca` branch. This can be achieved using a local `pip` install, e.g.::
2220

23-
$ git clone git@github.com:flatironinstitute/adapol.git --branch main
21+
$ git clone git@github.com:flatironinstitute/adapol.git --branch triqs_xca
2422
$ python -m pip install -e ./adapol
2523

2624
#. The `pyed <https://github.com/HugoStrand/pyed>`_ package (PYED: Exact diagonalization for finite quantum systems) has to be available in the python environment. This can be tested by running::

0 commit comments

Comments
 (0)