Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ on:
paths:
- "docs/**"
- "mkdocs.yml"
- "lidmas+/frontend/**"
- ".github/workflows/docs.yml"
workflow_dispatch:

Expand Down Expand Up @@ -39,6 +40,23 @@ jobs:
- name: Build docs
run: mkdocs build --strict

- uses: actions/setup-node@v4
with:
node-version: "20"
cache: npm
cache-dependency-path: lidmas+/frontend/package-lock.json

- name: Build LiDMaS+ UI
working-directory: lidmas+/frontend
run: |
npm ci
npm run build

- name: Add LiDMaS+ UI to Pages artifact
run: |
mkdir -p site/ui
cp -R lidmas+/frontend/dist/. site/ui/

- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
Expand Down
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
<img src="https://img.shields.io/badge/C%2B%2B-20-black?logo=c%2B%2B&logoColor=white" />
<img src="https://img.shields.io/badge/build-CMake-black?logo=cmake&logoColor=white" />
<a href="https://pypi.org/project/lidmas/"><img src="https://img.shields.io/pypi/v/lidmas?label=PyPI&logo=pypi" /></a>
<a href="https://github.com/DennisWayo/lidmas_cpp/actions/workflows/ci.yml"><img src="https://github.com/DennisWayo/lidmas_cpp/actions/workflows/ci.yml/badge.svg" /></a>
<a href="https://denniswayo.github.io/lidmas_cpp/"><img src="https://img.shields.io/website?url=https%3A%2F%2Fdenniswayo.github.io%2Flidmas_cpp%2F&label=docs&logo=github" /></a>
<img src="https://img.shields.io/github/license/DennisWayo/lidmas_cpp?color=black" />
<a href="https://github.com/Gottesman-Software/lidmas_cpp/actions/workflows/ci.yml"><img src="https://github.com/Gottesman-Software/lidmas_cpp/actions/workflows/ci.yml/badge.svg" /></a>
<a href="https://gottesman-software.github.io/lidmas_cpp/"><img src="https://img.shields.io/website?url=https%3A%2F%2Fgottesman-software.github.io%2Flidmas_cpp%2F&label=docs&logo=github" /></a>
<img src="https://img.shields.io/github/license/Gottesman-Software/lidmas_cpp?color=black" />
</p>

LiDMaS+ is an open-source CLI toolkit for reproducible quantum error-correction simulation, decoder benchmarking, and hardware-to-decoder replay. This exists to make QEC experiments reproducible, scriptable, and directly comparable across codes, decoders, and hardware data pipelines.
Expand All @@ -27,7 +27,7 @@ It provides:
- deterministic runs with explicit seed control,
- reusable examples for thresholds, replay, and analysis outputs.

If you need the full technical depth, use the published [docs](https://denniswayo.github.io/lidmas_cpp/)
If you need the full technical depth, use the published [docs](https://gottesman-software.github.io/lidmas_cpp/)

## Statement of Need

Expand Down Expand Up @@ -92,6 +92,7 @@ Step map:
![LiDMaS+ UI preview (active development)](docs/images/ui_active_development.png)

UI status: under active development. For stable workflows today, use the CLI (`lidmas`) below.
Online UI: https://gottesman-software.github.io/lidmas_cpp/ui/

## Getting Started

Expand Down Expand Up @@ -143,9 +144,9 @@ Run from source build (without PyPI install):

For full examples and workflow guides:

- [Getting-Started](https://denniswayo.github.io/lidmas_cpp/getting-started/)
- [CLI-reference](https://denniswayo.github.io/lidmas_cpp/cli-reference/)
- [Examples-workflows](https://denniswayo.github.io/lidmas_cpp/examples-workflows/)
- [Getting-Started](https://gottesman-software.github.io/lidmas_cpp/getting-started/)
- [CLI-reference](https://gottesman-software.github.io/lidmas_cpp/cli-reference/)
- [Examples-workflows](https://gottesman-software.github.io/lidmas_cpp/examples-workflows/)

## Hardware Integrations

Expand All @@ -157,7 +158,7 @@ For full examples and workflow guides:
| Replay | Xanadu Aurora/QCA/GKP dataset conversion + replay | Xanadu | Python converter + LiDMaS `decoder_io_replay` |
| Replay | Simulator framework replay | PennyLane / Qiskit / Cirq ecosystems | PennyLane, Qiskit, Cirq |

Hardware Integration examples and commands are documented [here](https://denniswayo.github.io/lidmas_cpp/hardware-integration/)
Hardware Integration examples and commands are documented [here](https://gottesman-software.github.io/lidmas_cpp/hardware-integration/)

## Contributing

Expand Down
4 changes: 2 additions & 2 deletions docs/readthedocs-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This repository includes the files required for automatic Read the Docs builds:
## Enable on Read the Docs

1. Sign in to Read the Docs.
2. Import `DennisWayo/lidmas_cpp` from GitHub.
2. Import `Gottesman-Software/lidmas_cpp` from GitHub.
3. Confirm the default branch and Python version (configured in `.readthedocs.yaml`).
4. Trigger a build.

Expand Down Expand Up @@ -42,4 +42,4 @@ In repository settings:

Published URL:

- `https://denniswayo.github.io/lidmas_cpp/`
- `https://gottesman-software.github.io/lidmas_cpp/`
2 changes: 1 addition & 1 deletion docs/releases/v1.2.0-rc.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This release candidate focuses on Xanadu hardware-data integration and large-dat
- `feat(hardware): add streaming Xanadu dataset integration` (`a544e2b`)

Comparison:
`https://github.com/DennisWayo/lidmas_cpp/compare/v1.1.4...v1.2.0-rc.1`
`https://github.com/Gottesman-Software/lidmas_cpp/compare/v1.1.4...v1.2.0-rc.1`

## Validation Performed

Expand Down
2 changes: 1 addition & 1 deletion docs/releases/v1.2.0-rc.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This release candidate focuses on Xanadu hardware-data integration and large-dat
- `feat(hardware): add streaming Xanadu dataset integration` (`a544e2b`)

Comparison:
`https://github.com/DennisWayo/lidmas_cpp/compare/v1.1.4...v1.2.0-rc.2`
`https://github.com/Gottesman-Software/lidmas_cpp/compare/v1.1.4...v1.2.0-rc.2`

## Validation Performed

Expand Down
2 changes: 1 addition & 1 deletion docs/reproducibility-citation.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Suggested software citation:

```text
Wayo, D. (Year). LiDMaS+ (Version X.Y.Z) [Computer software].
https://github.com/DennisWayo/lidmas_cpp
https://github.com/Gottesman-Software/lidmas_cpp
```

## License
Expand Down
4 changes: 2 additions & 2 deletions lidmas+/frontend/src/ui/pages/HelpPage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ interface FaqItem {
answer: string;
}

const DOCUMENTATION_URL = "https://denniswayo.github.io/lidmas_cpp/";
const DOCUMENTATION_URL = "https://gottesman-software.github.io/lidmas_cpp/";

const helpCards: HelpCard[] = [
{
Expand Down Expand Up @@ -49,7 +49,7 @@ const helpCards: HelpCard[] = [
title: "Release Notes",
description: "Track features, fixes, and compatibility changes per version.",
cta: "View Releases →",
href: "https://github.com/DennisWayo/lidmas_cpp/releases",
href: "https://github.com/Gottesman-Software/lidmas_cpp/releases",
},
];

Expand Down
1 change: 1 addition & 0 deletions lidmas+/frontend/vite.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import react from "@vitejs/plugin-react";
import path from "path";

export default defineConfig({
base: "/lidmas_cpp/ui/",
plugins: [react()],
resolve: {
alias: {
Expand Down
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
site_name: LiDMaS+
site_description: Logical Injection & Decoding Modeling System
site_url: https://denniswayo.github.io/lidmas_cpp/
repo_url: https://github.com/DennisWayo/lidmas_cpp
repo_name: DennisWayo/lidmas_cpp
site_url: https://gottesman-software.github.io/lidmas_cpp/
repo_url: https://github.com/Gottesman-Software/lidmas_cpp
repo_name: Gottesman-Software/lidmas_cpp
docs_dir: docs

theme:
Expand Down
Loading