Skip to content

Add suggested citations to DMRG banner - #129

Open
egull wants to merge 1 commit into
masterfrom
dmrg_citation
Open

Add suggested citations to DMRG banner#129
egull wants to merge 1 commit into
masterfrom
dmrg_citation

Conversation

@egull

@egull egull commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Summary

  • print the recommended ALPS and DMRG citations in the DMRG startup banner
  • centralize DMRG copyright and citation output for both entry points

Testing

  • cmake --build build --target dmrg -j4
  • build/applications/dmrg/dmrg/dmrg --help
  • git diff --check

@egull
egull requested review from Ooolab and skilledwolf August 20, 2026 18:35
<< "* Recommended citation in scientific publications: *\n"
<< "* This code used the ALPS [1] implementation [2] of DMRG [3-6]. *\n"
<< "* [1] JSTAT (2011) P05001; *\n"
<< "* [2] A.E. Feiguin, The Density Matrix Renormalization Group. In: *\n"

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, I checked out the list of citations, and just wanted to ask for two minor clarifications:

Could it be that Ref [2] is not currently listed on the website https://alps.comp-phys.org/documentation/pubs/refs/ ? The DOI of [2] appears to be 10.1007/978-3-642-35106-8_2. Should it be added to the website?

Also, the website lists "M. Dolfi, B. Bauer, S. Keller, A. Kosenkov, T. Ewart, A. Kantian, T. Giamarchi, and M. Troyer, Matrix product state applications for the ALPS project, Comput. Phys. Commun. 185, 3430 (2014).", which doesn't seem to be in this list? Should it be added here?

@skilledwolf skilledwolf left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed a minor discrepancy in comparison to the website's citation list (see comment), but I don't think it's blocking for this PR.

It might be worth follow-up PR for the banner and the website at some point, to make sure we are consistent.

@egull

egull commented Aug 20, 2026 via email

Copy link
Copy Markdown
Contributor Author

@egull
egull requested a review from vws100 August 20, 2026 19:47
@egull

egull commented Aug 20, 2026

Copy link
Copy Markdown
Contributor Author

...adding Adrian (since he's the final authority on the dmrg code and cross-checked the citation statement) and Vito (since he wants consistent citation blocks).

vws100
vws100 previously requested changes Aug 24, 2026

@vws100 vws100 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The format for citations that we agreed on should have 3 tiers. @afeiguin is this correct ? If so we can limit the citations to this. ALPS release will have to be updated to 3.0 since you've update

  1. Original Code:
    S. White: Phys. Rev. Lett. 69, 2863 (1992);Phys. Rev. B 48, 10345 (1993)

2 . Implementation

A.E. Feiguin, The Density Matrix Renormalization Group. In:
Strongly Correlated Systems. Springer Series in Solid-State Sciences, vol 176 (2013)

  1. ALPS Release

@egull

egull commented Aug 25, 2026

Copy link
Copy Markdown
Contributor Author

I think the thought here is that it has three tiers. ALPS tier is our ALPS paper (Bauer 2011 for now). Implementation is Adrian's proceedings paper. Algorithm is not a single paper but a set of four references: 2 White papers (for 'original literature') and two reviews (Schollwöck, Hallberg).
We removed a whole bunch of less relevant and MPS papers, but if Adrian thinks that the DMRG code should be referenced with those four papers for the algorithm then why not (none of them go to ALPS authors, so that's really just what should be done in the field, and it's up to people in the field to decide). CT-QMC is similar: There is an implementation paper, the ALPS paper, and two reference papers for the algorithm (original & review) since not everything relevant is in the original paper and likely the original paper is not the most useful citation anyway.

@Ooolab Ooolab left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't know as much history as you. But I will approve this and let you guys decide.

@vws100
vws100 dismissed their stale review August 26, 2026 21:10

Okay sounds good

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants