From b930a6085166872da4ceb0c7630cf4adbc4ffaf1 Mon Sep 17 00:00:00 2001 From: Hiroshi Shinaoka Date: Tue, 26 Nov 2024 22:42:42 -0500 Subject: [PATCH] Update README --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 3be3683..de24102 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,12 @@ [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://tensor4all.github.io/PartitionedMPSs.jl/dev) [![CI](https://github.com/tensor4all/PartitionedMPSs.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/tensor4all/PartitionedMPSs.jl/actions/workflows/CI.yml) + +## General Information +This library provides an implementation of partitioned matrix product states (MPSs) in Julia. A `PartitionedMPS` object is a collection of `SubDomainMPS` objects, each of which is an MPS projected on a subdomain of the whole index set. +This library also provides a block-wise multiplication of partitioned MPSs. + + +## Usage + +Please refer to the [documentation](https://tensor4all.github.io/PartitionedMPSs.jl/) for usage. \ No newline at end of file