Prepare for v0.8.12.

Quantum-Many-Body · Apr 18, 2022 · 244eaa1 · 244eaa1
1 parent 7d2cb95
commit 244eaa1
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 14 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "QuantumLattices"
 uuid = "78ae1a1f-1d5d-5174-b61c-66e31b2346dc"
 authors = ["waltergu <[email protected]>"]
-version = "0.8.11"
+version = "0.8.12"
 
 [deps]
 DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"

diff --git a/README.md b/README.md
@@ -10,11 +10,11 @@
 
 *Julia package for the construction of quantum lattice systems.*
 
-Welcome to [QuantumLattices](https://github.com/Quantum-Many-Body/QuantumLattices.jl). Here we provide a general framework to construct the **second-quantized operator-formed Hamiltonian of any quantum lattice system**, with the inputs as simple as its description by the natural language. Combined with [SymPy](https://github.com/JuliaPy/SymPy.jl), this operator-formed Hamiltonian supports **complete symbolic computations**, making it a convenient prerequisite of quantum many-body algorithms, such as **TBA**(tight-bind approximation), **SCMF**(self-consistent mean field theory), **ED**(exact diagonalization), **CPT/VCA**(cluster perturbation theory and variational cluster approach ), **DMRG**(density matrix renormalization group), etc. Generic interfaces are defined to provide a unified access to these algorithms which would be implemented in separate packages. Only minor modifications need be made when users alter from one algorithm to another.
+Welcome to [QuantumLattices](https://github.com/Quantum-Many-Body/QuantumLattices.jl). Here we provide a general framework to construct the **second-quantized operator-formed Hamiltonian of any quantum lattice system**, with the inputs as simple as its description by the natural language. Combined with [SymPy](https://github.com/JuliaPy/SymPy.jl), this operator-formed Hamiltonian supports **complete symbolic computations**, making it a convenient "frontend" of quantum many-body algorithms, such as **TBA**(tight-bind approximation), **LSWT**(linear spin wave theory), **SCMF**(self-consistent mean field theory), **ED**(exact diagonalization), **CPT/VCA**(cluster perturbation theory and variational cluster approach ), **DMRG**(density matrix renormalization group), etc. Generic interfaces are defined to provide a unified access to these algorithms which would be implemented in separate packages. Only minor modifications need be made when users alter from one algorithm to another.
 
 ## Installation
 
-In Julia **v1.1+**, please type `]` in the REPL to use the package mode, then type this command:
+In Julia **v1.6+**, please type `]` in the REPL to use the package mode, then type this command:
 
 ```julia
 pkg> add QuantumLattices
@@ -33,16 +33,16 @@ It is noted that our implementation of the symbolic computation only involves
 * the mathematical operations between two operators.
 
 The symbolic operations between two scalars are **not** implemented because:
-* in condensed matter physics, for many cases, only the numerical values of operators are important because the analytical expressions can be too complicated to analyze or they may even not exist;
+* in condensed matter physics, for many cases, only the numerical values of operators are relevant because the analytical expressions could be too complicated to analyze or they may even not exist;
 * our construction process of the operators and their mathematical operations are **compatible with the [SymPy](https://github.com/JuliaPy/SymPy.jl) package**, therefore, a fully symbolic computation can be achieved by a simple combination of both.
 
-Another major aim of this package is to provide unified interfaces to access all quantum many-body algorithms. Much of the job can be done by the construction of the operator-formed Hamiltonian, which serves as a common input for different algorithms. The remaining stuff concerns mainly with project management, such as result recording, data caching, parameter updating, code logging, dependency managing, etc. Utilities are provided to handle these tasks.
+The major aim of this package is to provide **unified "frontend" to access all quantum many-body algorithms**. Much of the job can be done by the construction of the operator-formed Hamiltonian, which serves as a common input for different algorithms. Utilities are also provided to deal with the project management, such as result recording, data caching, parameter updating, code logging, dependency managing, etc.
 
 ## Package Features
 
 * **Unitcell Description Framework**: by telling the information of the quantum lattice system within a unitcell, the construction of the symbolic representation of the Hamiltonian is just as simple as describing the system in a usual research paper.
 * **Complete Symbolic Computation**: with only this package, symbolic computation between operators is realized whereas the coefficient of any operator remains numeric; by integrating it with [SymPy](https://github.com/JuliaPy/SymPy.jl), complete symbolic computation can be achieved and no modifications need be made on the methods in this package.
-* **Generic Many-Body Algorithmic Interfaces**: quantum many-body algorithms can be initialized in quite similar ways with only minor modifications needed. Moreover, automatic project management is realized, including that of result recording, data caching, parameter updating, code logging, dependency managing, etc.
+* **Generic Frontend of Many-Body Algorithms**: quantum many-body algorithms can be initialized in quite similar ways with only minor modifications needed. Moreover, automatic project management is realized, including that of result recording, data caching, parameter updating, code logging, dependency managing, etc.
 
 ## Supported Systems
 
@@ -56,7 +56,7 @@ Furthermore, other systems can be supported easily by extending the generic "pro
 
 ## Supported Algorithms
 
-Concrete algorithms are implemented in separate packages (still in progress):
+Concrete algorithms could be considered as the "backend" of quantum lattice systems. They are developed in separate packages (still in progress):
 * **[TBA](https://github.com/Quantum-Many-Body/TightBindingApproximation.jl)**: tight-binding approximation for fermionic/bosonic systems;
 * **SCMF**: self-consistent mean field theory for fermionic systems;
 * **[ED](https://github.com/Quantum-Many-Body/ExactDiagonalization.jl)**: exact diagonalization for fermionic/hard-core-bosonic/spin systems;

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -6,7 +6,15 @@ CurrentModule=QuantumLattices
 
 *Julia package for the construction of quantum lattice systems.*
 
-Welcome to [QuantumLattices](https://github.com/Quantum-Many-Body/QuantumLattices.jl). Here we provide a general framework to construct the **second-quantized operator-formed Hamiltonian of any quantum lattice system**, with the inputs as simple as its description by the natural language. Combined with [SymPy](https://github.com/JuliaPy/SymPy.jl), this operator-formed Hamiltonian supports **complete symbolic computations**, making it a convenient prerequisite of quantum many-body algorithms, such as **TBA**(tight-bind approximation), **SCMF**(self-consistent mean field theory), **ED**(exact diagonalization), **CPT/VCA**(cluster perturbation theory and variational cluster approach ), **DMRG**(density matrix renormalization group), etc. Generic interfaces are defined to provide a unified access to these algorithms which would be implemented in separate packages. Only minor modifications need be made when users alter from one algorithm to another.
+Welcome to [QuantumLattices](https://github.com/Quantum-Many-Body/QuantumLattices.jl). Here we provide a general framework to construct the **second-quantized operator-formed Hamiltonian of any quantum lattice system**, with the inputs as simple as its description by the natural language. Combined with [SymPy](https://github.com/JuliaPy/SymPy.jl), this operator-formed Hamiltonian supports **complete symbolic computations**, making it a convenient "frontend" of quantum many-body algorithms, such as **TBA**(tight-bind approximation), **LSWT**(linear spin wave theory), **SCMF**(self-consistent mean field theory), **ED**(exact diagonalization), **CPT/VCA**(cluster perturbation theory and variational cluster approach ), **DMRG**(density matrix renormalization group), etc. Generic interfaces are defined to provide a unified access to these algorithms which would be implemented in separate packages. Only minor modifications need be made when users alter from one algorithm to another.
+
+## Installation
+
+In Julia **v1.6+**, please type `]` in the REPL to use the package mode, then type this command:
+
+```julia
+pkg> add QuantumLattices
+```
 
 ## Introduction
 
@@ -21,16 +29,16 @@ It is noted that our implementation of the symbolic computation only involves
 * the mathematical operations between two operators.
 
 The symbolic operations between two scalars are **not** implemented because:
-* in condensed matter physics, for many cases, only the numerical values of operators are important because the analytical expressions can be too complicated to analyze or they may even not exist;
+* in condensed matter physics, for many cases, only the numerical values of operators are relevant because the analytical expressions could be too complicated to analyze or they may even not exist;
 * our construction process of the operators and their mathematical operations are **compatible with the [SymPy](https://github.com/JuliaPy/SymPy.jl) package**, therefore, a fully symbolic computation can be achieved by a simple combination of both.
 
-Another major aim of this package is to provide unified interfaces to access all quantum many-body algorithms. Much of the job can be done by the construction of the operator-formed Hamiltonian, which serves as a common input for different algorithms. The remaining stuff concerns mainly with project management, such as result recording, data caching, parameter updating, code logging, dependency managing, etc. Utilities are provided to handle these tasks.
+The major aim of this package is to provide **unified "frontend" to access all quantum many-body algorithms**. Much of the job can be done by the construction of the operator-formed Hamiltonian, which serves as a common input for different algorithms. Utilities are also provided to deal with the project management, such as result recording, data caching, parameter updating, code logging, dependency managing, etc.
 
 ## Package Features
 
 * **Unitcell Description Framework**: by telling the information of the quantum lattice system within a unitcell, the construction of the symbolic representation of the Hamiltonian is just as simple as describing the system in a usual research paper.
 * **Complete Symbolic Computation**: with only this package, symbolic computation between operators is realized whereas the coefficient of any operator remains numeric; by integrating it with [SymPy](https://github.com/JuliaPy/SymPy.jl), complete symbolic computation can be achieved and no modifications need be made on the methods in this package.
-* **Generic Many-Body Algorithmic Interfaces**: quantum many-body algorithms can be initialized in quite similar ways with only minor modifications needed. Moreover, automatic project management is realized, including that of result recording, data caching, parameter updating, code logging, dependency managing, etc.
+* **Generic Frontend of Many-Body Algorithms**: quantum many-body algorithms can be initialized in quite similar ways with only minor modifications needed. Moreover, automatic project management is realized, including that of result recording, data caching, parameter updating, code logging, dependency managing, etc.
 
 ## Supported Systems
 
@@ -44,7 +52,7 @@ Furthermore, other systems can be supported easily by extending the generic "pro
 
 ## Supported Algorithms
 
-Concrete algorithms are implemented in separate packages (still in progress):
+Concrete algorithms could be considered as the "backend" of quantum lattice systems. They are developed in separate packages (still in progress):
 * **[TBA](https://github.com/Quantum-Many-Body/TightBindingApproximation.jl)**: tight-binding approximation for fermionic/bosonic systems;
 * **SCMF**: self-consistent mean field theory for fermionic systems;
 * **[ED](https://github.com/Quantum-Many-Body/ExactDiagonalization.jl)**: exact diagonalization for fermionic/hard-core-bosonic/spin systems;
@@ -53,7 +61,14 @@ Concrete algorithms are implemented in separate packages (still in progress):
 * **[SWT](https://github.com/Quantum-Many-Body/SpinWaveTheory.jl)**: spin wave theory for local spin systems.
 
 ## Getting Started
-[Tutorials: unitcell description](https://quantum-many-body.github.io/QuantumLattices.jl/dev/tutorials/UnitcellDescription/)
+[Tutorials: unitcell description](https://quantum-many-body.github.io/QuantumLattices.jl/dev/tutorials/UnitcellDescription/Introduction/)
+
+## Note
+
+Due to the fast development of this package, releases with different minor version numbers are **not** guaranteed to be compatible with previous ones **before** the release of v1.0.0. Comments are welcomed in the GitHub issues.
+
+## Contact
+[email protected]
 
 ## Python counterpart
-[HamiltonianPy](https://github.com/waltergu/HamiltonianPy): in fact, the authors of this Julia package worked on the python package at first and only turned to Julia later.
+[HamiltonianPy](https://github.com/waltergu/HamiltonianPy): in fact, the authors of this Julia package worked on the python package at first and only turned to Julia later.