update docs

QuantumBFS · Mar 12, 2024 · 9086de3 · 9086de3
1 parent 0b2a696
commit 9086de3
Show file tree

Hide file tree

Showing 16 changed files with 112 additions and 270 deletions.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,17 @@
+JL = julia --project
+
+default: init
+
+init:
+	$(JL) -e 'using Pkg; Pkg.instantiate(); Pkg.precompile(); Pkg.activate("docs"); Pkg.instantiate(); Pkg.precompile()'
+
+update:
+	$(JL) -e 'using Pkg; Pkg.update(); Pkg.precompile(); Pkg.activate("docs"); Pkg.update(); Pkg.precompile()'
+
+serve:
+	$(JL) -e 'using Pkg; Pkg.activate("docs"); using LiveServer; servedocs(; skip_files=["docs/src/assets/indigo.css"])'
+
+clean:
+	rm -rf docs/build
+
+.PHONY: init
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -2,3 +2,4 @@
 BitBasis = "50ba71b6-fa0f-514d-ae9a-0916efc90dcf"
 DocThemeIndigo = "8bac0ac5-51bf-41f9-885e-2bf1ac2bec5f"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
diff --git a/docs/draw.jl b/docs/draw.jl
diff --git a/docs/src/assets/010101.png b/docs/src/assets/010101.png
diff --git a/docs/src/assets/1011_1101.png b/docs/src/assets/1011_1101.png
diff --git a/docs/src/assets/11100.png b/docs/src/assets/11100.png
diff --git a/docs/src/assets/bitbasic.png b/docs/src/assets/bitbasic.png
diff --git a/docs/src/assets/breflect.png b/docs/src/assets/breflect.png
diff --git a/docs/src/assets/btruncate.png b/docs/src/assets/btruncate.png
diff --git a/docs/src/assets/flip.png b/docs/src/assets/flip.png
diff --git a/docs/src/assets/ismatch.png b/docs/src/assets/ismatch.png
diff --git a/docs/src/assets/neg.png b/docs/src/assets/neg.png
diff --git a/docs/src/assets/setbit.png b/docs/src/assets/setbit.png
diff --git a/docs/src/assets/swapbits.png b/docs/src/assets/swapbits.png
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -6,7 +6,7 @@ end
 
 # BitBasis
 
-Types and operations for basis represented by bits in linear algebra.
+Manipulate binary (and nary) basis in an elegant efficient way in Julia.
 
 ```@eval
 using Markdown, Dates
@@ -15,10 +15,7 @@ Markdown.parse("*Documentation built* **$(Dates.now())** *with Julia* **$(VERSIO
 
 ## Introduction
 
-The basis of linear spaces can be marked by a set of symbols, for concrete physical systems, this can be binary spins, bits, qubits, etc. They can be in general represented as binary basis, e.g `00101`, `10101`....
-
-This package provides tools for manipulating such basis in an elegant efficient way in Julia.
-
+This package provides tools for manipulating binary basis in an elegant efficient way in Julia. Binary basis are used to represent states of spins, qubits, qudits, etc. It stores the basis as an integer with little-endian ordering, e.g `5` for `00101`, `6` for `00110`, etc.
 
 ## Contents
 ```@contents