Skip to content

Commit

Permalink
Merge pull request #9 from tensor4all/update-readme
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
shinaoka authored Jul 17, 2024
2 parents bdbc7a0 + 28fb46e commit e2c9477
Showing 1 changed file with 9 additions and 18 deletions.
27 changes: 9 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,17 @@
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://tensor4all.github.io/Quantics.jl/dev)
[![CI](https://github.com/tensor4all/Quantics.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/tensor4all/Quantics.jl/actions/workflows/CI.yml)

## Prerequisites
This library provides a high-level interface to manipulate quantics tensor train (QTT) format in Julia such as Fourier transform, convolution, and matrix-vector multiplication.
This library is based on `ITensors.jl`.

```console
cd path/to/Quantics.jl
$ julia --project=@.
_
_ _ _(_)_ | Documentation: https://docs.julialang.org
(_) | (_) (_) |
_ _ _| |_ __ _ | Type "?" for help, "]?" for Pkg help.
| | | | | | |/ _` | |
| | |_| | | | (_| | | Version 1.9.4 (2023-11-14)
_/ |\__'_|_|_|\__'_| | Official https://julialang.org/ release
|__/ |
## Installation

julia> using Pkg; Pkg.instantiate()
```

## Test this package
The following will install `Quantics.jl`:

```console
$ julia --project=@. -e 'using Pkg; Pkg.test()'
```julia
julia> using Pkg; Pkg.add("Quantics.jl")
```

## Usage

Please refer to the [documentation](https://tensor4all.github.io/Quantics.jl/) for usage.

0 comments on commit e2c9477

Please sign in to comment.