TeNPy Logo
latest

User guide

  • README
    • TeNPy: Tensor Network Python
    • How do I get set up?
    • How to read the documentation
    • Help - I looked at the documentation, but I don’t understand how …?
    • I found a bug
    • Citing TeNPy
    • Acknowledgment
    • License
  • Installation instructions
    • Installation with conda from conda-forge
    • Installation from PyPi with pip
      • Preparation: install requirements
      • Installing the latest stable TeNPy package
      • Installation of the latest version from Github
      • Installation from the downloaded source folder
      • Uninstalling a pip-installed version
    • Updating to a new version
      • When installed with conda
      • When installed with pip
      • When installed from source
    • Installation from source
      • Minimal Requirements
      • Getting the source
      • Minimal installation: Including tenpy into PYTHONPATH
      • Compilation of np_conserved
      • Quick-setup of a development environment with conda
    • Extra requirements
      • Matplotlib
      • Intel’s Math Kernel Library (MKL)
        • Compile linking agains MKL
      • HDF5 file format support
      • YAML parameter files
      • Tests
    • Checking the installation
    • TeNPy developer team
    • License
  • Release Notes
    • [latest]
      • Release Notes
      • Changelog
        • Backwards incompatible changes
        • Added
        • Changed
        • Fixed
    • [v0.8.4] - 2021-03-29
    • [v0.8.3] - 2021-03-29
    • [v0.8.2] - 2021-03-25
    • [v0.8.1] - 2021-03-23
    • [v0.8.0] - 2021-03-19
      • Release Notes
      • Changelog
        • Backwards incompatible changes
        • Added
        • Changed
        • Fixed
    • [0.7.2] - 2020-10-09
      • Release Notes
      • Changelog
        • Backwards incompatible changes
        • Added
        • Fixed
    • [0.7.1] - 2020-09-04
      • Release Notes
    • [0.7.0] - 2020-09-04
      • Release Notes
      • Changelog
        • Backwards incompatible changes
        • Added
        • Changed
        • Fixed
    • [0.6.1] - 2020-05-18
      • Release Notes
    • [0.6.0] - 2020-05-16
      • Release Notes
      • Changelog
        • Backwards incompatible changes
        • Added
        • Changed
        • Fixed
    • [0.5.0] - 2019-12-18
      • Backwards incompatible changes
      • Changed
      • Added
      • Fixed
    • [0.4.1] - 2019-08-14
      • Backwards incompatible changes
      • Changed
      • Added
      • Fixed
    • [0.4.0] - 2019-04-28
      • Backwards incompatible changes
      • Added
      • Changed
      • Fixed
      • Removed
    • [0.3.0] - 2018-02-19
      • Added
      • Changed
      • Removed
    • [0.2.0] - 2017-02-24
    • Changes compared to previous TeNPy
      • Global Changes
      • np_conserved
      • TEBD
      • DMRG
      • Tools
  • Introductions
    • Overview
      • Repository
      • Code structure: getting started
        • Most basic level: linear algebra
        • Sites for the local Hilbert space and tensor networks
        • Models
        • Algorithms
        • Simulations
    • Charge conservation with np_conserved
      • What you really need to know about np_conserved
      • Introduction to combine_legs, split_legs and LegPipes
      • Leg labeling
      • Indexing of an Array
      • Details of the np_conserved implementation
        • Notations
        • Physical Example
        • The different formats for LegCharge
        • Which entries of the npc Array can be non-zero?
        • The pesky qconj - contraction as an example
        • Assigning charges to non-physical legs
        • Array creation
        • Complete blocking of Charges
        • Internal Storage schema of npc Arrays
      • See also
      • A full example code for spin-1/2
    • Models
      • What is a model?
      • The Hilbert space
      • The geometry : lattice class
      • The CouplingModel: general structure
      • The easiest way: the CouplingMPOModel
      • Automation of Hermitian conjugation
      • Non-uniform terms and couplings
      • Some random remarks on models
    • Simulations
    • Details on the lattice geometry
      • Visualization
      • How an MPS winds through the lattice: the order
      • Boundary conditions
      • Irregular Lattices
    • Logging and terminal output
      • Configuring logging
      • How to write your own logging (and warning) code
    • Parameters and options
    • Saving to disk: input/output
      • Using pickle
      • Using HDF5 with h5py
        • Data format specification for saving to HDF5
    • Fermions and the Jordan-Wigner transformation
      • Spinless fermions in 1D
      • Higher dimensions
      • Spinful fermions
      • How to handle Jordan-Wigner strings in practice
    • Protocol for using (i)DMRG
      • Confirming the model is correct
      • Low-effort tests
      • Detecting convergence issues
      • Combating convergence issues
  • Examples
    • Toycodes
      • a_mps.py
      • b_model.py
      • c_tebd.py
      • d_dmrg.py
      • tfi_exact.py
    • Python scripts
      • a_np_conserved.py
      • b_mps.py
      • c_tebd.py
      • d_dmrg.py
      • e_tdvp.py
      • purification.py
      • tfi_exact.py
      • z_exact_diag.py
    • Jupyter Notebooks
      • A first TEBD Example
      • A first finite DMRG Example
        • Expectation Values
      • Lattices: visualization and further examples
        • plotting the lattice itself
        • Visually verifying pairs of couplings by plotting them
      • Toric Code
        • Extending the existing model
        • iDMRG
        • Topological entanglement entropy
  • Troubleshooting and FAQ
    • I get an error when …
    • I get a warning about …
  • Literature and References
    • TeNPy related sources
    • Software-related
    • General reading
    • Algorithm developments
    • References
  • Papers using TeNPy
  • Contributing
    • Coding Guidelines
    • Bulding the documentation
    • To-Do list

Reference

  • Tenpy main module
    • run_simulation
    • console_main
    • show_config
  • algorithms
    • algorithm
      • Algorithm
      • TimeEvolutionAlgorithm
    • truncation
      • TruncationError
      • svd_theta
      • truncate
    • tebd
      • Engine
      • RandomUnitaryEvolution
      • TEBDEngine
    • mps_common
      • EffectiveH
      • OneSiteH
      • Sweep
      • TwoSiteH
      • VariationalApplyMPO
      • VariationalCompression
    • dmrg
      • DMRGEngine
      • DensityMatrixMixer
      • EngineCombine
      • EngineFracture
      • Mixer
      • SingleSiteDMRGEngine
      • SingleSiteMixer
      • TwoSiteDMRGEngine
      • TwoSiteMixer
      • chi_list
      • full_diag_effH
      • run
    • tdvp
      • Engine
      • H0_mixed
      • H1_mixed
      • H2_mixed
      • TDVPEngine
    • purification
      • PurificationApplyMPO
      • PurificationTEBD
      • PurificationTEBD2
      • PurificationTwoSiteU
    • mpo_evolution
      • ExpMPOEvolution
    • network_contractor
      • contract
      • ncon
    • exact_diag
      • ExactDiag
  • linalg
    • np_conserved
      • Array
      • concatenate
      • detect_grid_outer_legcharge
      • detect_legcharge
      • detect_qtotal
      • diag
      • eig
      • eigh
      • eigvals
      • eigvalsh
      • expm
      • eye_like
      • grid_concat
      • grid_outer
      • inner
      • norm
      • ones
      • outer
      • pinv
      • qr
      • speigs
      • svd
      • tensordot
      • to_iterable_arrays
      • trace
      • zeros
      • Overview
    • charges
      • ChargeInfo
      • LegCharge
      • LegPipe
    • svd_robust
      • svd
      • svd_gesvd
    • random_matrix
      • COE
      • CRE
      • CUE
      • GOE
      • GUE
      • O_close_1
      • U_close_1
      • box
      • standard_normal_complex
    • sparse
      • FlatHermitianOperator
      • FlatLinearOperator
      • NpcLinearOperator
      • NpcLinearOperatorWrapper
      • OrthogonalNpcLinearOperator
      • ShiftNpcLinearOperator
      • SumNpcLinearOperator
    • lanczos
      • LanczosEvolution
      • LanczosGroundState
      • gram_schmidt
      • lanczos
      • lanczos_arpack
      • plot_stats
  • models
    • lattice
      • Chain
      • HelicalLattice
      • Honeycomb
      • IrregularLattice
      • Kagome
      • Ladder
      • Lattice
      • SimpleLattice
      • Square
      • Triangular
      • TrivialLattice
      • get_lattice
      • get_order
      • get_order_grouped
    • model
      • CouplingMPOModel
      • CouplingModel
      • MPOModel
      • Model
      • MultiCouplingModel
      • NearestNeighborModel
    • tf_ising
      • TFIChain
      • TFIModel
    • xxz_chain
      • XXZChain
      • XXZChain2
    • spins
      • SpinChain
      • SpinModel
    • spins_nnn
      • SpinChainNNN
      • SpinChainNNN2
    • fermions_spinless
      • FermionChain
      • FermionModel
    • hubbard
      • BoseHubbardChain
      • BoseHubbardModel
      • FermiHubbardChain
      • FermiHubbardModel
    • hofstadter
      • HofstadterBosons
      • HofstadterFermions
      • gauge_hopping
    • haldane
      • BosonicHaldaneModel
      • FermionicHaldaneModel
    • toric_code
      • DualSquare
      • ToricCode
  • networks
    • site
      • BosonSite
      • FermionSite
      • GroupedSite
      • Site
      • SpinHalfFermionSite
      • SpinHalfSite
      • SpinSite
      • group_sites
      • multi_sites_combine_charges
      • set_common_charges
    • mps
      • InitialStateBuilder
      • MPS
      • MPSEnvironment
      • TransferMatrix
      • build_initial_state
    • mpo
      • MPO
      • MPOEnvironment
      • MPOGraph
      • grid_insert_ops
      • make_W_II
    • terms
      • CouplingTerms
      • ExponentiallyDecayingTerms
      • MultiCouplingTerms
      • OnsiteTerms
      • TermList
      • order_combine_term
    • purification_mps
      • PurificationMPS
  • simulations
    • simulation
      • Simulation
      • Skip
      • output_filename_from_dict
      • resume_from_checkpoint
      • run_seq_simulations
      • run_simulation
    • measurement
      • bond_dimension
      • bond_energies
      • correlation_length
      • energy_MPO
      • entropy
      • evolved_time
      • measurement_index
      • onsite_expectation_value
    • ground_state_search
      • GroundStateSearch
    • time_evolution
      • RealTimeEvolution
  • tools
    • hdf5_io
      • Hdf5Exportable
      • Hdf5Ignored
      • Hdf5Loader
      • Hdf5Saver
      • Hdf5ExportError
      • Hdf5FormatError
      • Hdf5ImportError
      • find_global
      • load
      • load_from_hdf5
      • save
      • save_to_hdf5
      • valid_hdf5_path_component
    • params
      • Config
      • asConfig
      • get_parameter
      • unused_parameters
    • events
      • EventHandler
      • Listener
    • misc
      • add_with_None_0
      • any_nonzero
      • anynan
      • argsort
      • atleast_2d_pad
      • build_initial_state
      • chi_list
      • find_subclass
      • flatten
      • get_close
      • get_recursive
      • group_by_degeneracy
      • inverse_permutation
      • lexsort
      • list_to_dict_list
      • pad
      • set_recursive
      • setup_executable
      • setup_logging
      • to_array
      • to_iterable
      • to_iterable_of_len
      • transpose_list_list
      • update_recursive
      • zero_if_close
    • math
      • entropy
      • gcd
      • gcd_array
      • lcm
      • matvec_to_array
      • perm_sign
      • qr_li
      • rq_li
      • speigs
      • speigsh
    • fit
      • alg_decay
      • alg_decay_fit
      • alg_decay_fit_res
      • alg_decay_fits
      • central_charge_from_S_profile
      • entropy_profile_from_CFT
      • fit_with_sum_of_exp
      • lin_fit_res
      • linear_fit
      • plot_alg_decay_fit
      • sum_of_exp
    • string
      • is_non_string_iterable
      • to_mathematica_lists
      • vert_join
    • process
      • load_omp_library
      • memory_usage
      • mkl_get_nthreads
      • mkl_set_nthreads
      • omp_get_nthreads
      • omp_set_nthreads
    • optimization
      • OptimizationFlag
      • temporary_level
      • get_level
      • optimize
      • set_level
      • to_OptimizationFlag
      • use_cython
  • version
TeNPy
  • Docs »
  • Introductions
  • Edit on GitHub

Introductions¶

The following documents are meant as introductions to various topics relevant to TeNPy.

If you are new to TeNPy, read the Overview.

  • Overview
  • Charge conservation with np_conserved
  • Models
  • Simulations
  • Details on the lattice geometry
  • Logging and terminal output
  • Parameters and options
  • Saving to disk: input/output
  • Fermions and the Jordan-Wigner transformation
  • Protocol for using (i)DMRG
Next Previous

© Copyright 2016-2020, TeNPy Developers Revision 9b478b26.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
stable
v0.8.4
v0.8.3
v0.8.2
v0.8.1
v0.8.0
v0.7.2
v0.7.1
v0.7.0
v0.6.1
v0.6.0
v0.5.0
Downloads
pdf
html
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.