Skip to content

Update user guide #596

@manuschneider

Description

@manuschneider

The user guide on github has a version 1.0 already. However, it seems to be outdated and needs to be revisited.

The following changes were made to the API were made:

  • Contract, Contracts are merged into Contract
  • .relabel, .relabels are merged into .relabel
  • .relabel_, .relabels_ are merged into .relabel_
  • Svd_truncate has an additional optional argument min_blockdim to define a minimum dimension for each block

Also, we should include all parts from the paper where they are not mentioned in detail in the user guide (they can to many parts just be copied).

I would also merge chapters '9. linalg' and '11. linalg extension', such that it is easier to find SVD, QR, eigval.

Finally, the links to the API documentation seem to be broken.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Top priorityThe Issue that has top prioritydocsdocumentation/ user guide relatedhelp wantedExtra attention is needed

    Type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions