{"id":22882595,"url":"https://github.com/cqcl/tierkreis-viz","last_synced_at":"2025-03-31T16:38:26.942Z","repository":{"id":182835116,"uuid":"668268412","full_name":"CQCL/tierkreis-viz","owner":"CQCL","description":"Interactive Tierkreis graph vizualizer that runs in your browser.","archived":false,"fork":false,"pushed_at":"2023-08-01T10:24:34.000Z","size":228,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-06T21:46:25.707Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CQCL.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-19T12:10:48.000Z","updated_at":"2023-07-21T13:49:16.000Z","dependencies_parsed_at":null,"dependency_job_id":"8caf02c3-2fab-4003-82cf-71e7fcb65a3f","html_url":"https://github.com/CQCL/tierkreis-viz","commit_stats":null,"previous_names":["cqcl/tierkreis-viz"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Ftierkreis-viz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Ftierkreis-viz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Ftierkreis-viz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Ftierkreis-viz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CQCL","download_url":"https://codeload.github.com/CQCL/tierkreis-viz/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246499325,"owners_count":20787483,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-13T18:18:31.289Z","updated_at":"2025-03-31T16:38:26.936Z","avatar_url":"https://github.com/CQCL.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tierkreis Graph Visualizer\n\n## Running the visualizer \n### 🐋 Docker\n```bash\ndocker build -t tierkreis-viz .\ndocker run -it -p 3000:3000 --rm tierkreis-viz # Runs on port 3000.\n```\n### ⬣ Node\nMake sure you are using [node](https://nodejs.org/en) v16.8 or higher.\n```bash\nnpm i\nnpm run build\nnpm run start\n```\n\n\n## Using the vizualizer\n`tierkreis/examples/viz_demo.ipynb` and `tierkreis/examples/variational-viz.ipynb` contain a few example notebooks to get started. Connecting to the vizualiser requires instrumenting tierkreis with the VizRuntime plugin. \n```python\nfrom tierkreis.pyruntime.python_runtime import VizRuntime\n...\ncl = VizRuntime(\"http://localhost:3000\", [test_worker.main.root, ...])\n...\n```\nThe visualizer responds to 3 different commands.\n```python\ncl.viz_graph(graph) # Renders the graph in the vizualizer.\ncl.type_check_graph(graph) # Highlights nodes which have type errors.\ncl.run_graph(graph) # Shows the runtime state of the graph.\n```\n\nExample of a tierkreis graph being run with the visualizer:\n\n\n\u003cimg width=\"1512\" alt=\"Screenshot 2023-07-20 at 00 12 38\" src=\"https://github.com/CQCL/tierkreis-viz/assets/104831665/ba18af83-6eef-4475-8a2c-6ea8c97c8ac4\"\u003e\n\n\n\u003e **⚠️ Note:**\n\u003e Runtime updates are not currently supported for nested graphs (box types). We recommend unboxing nested graphs if you would like accurate visual runtime updates.\n\n## Development\nThis visualizer is built with [React](https://react.dev/), [NextJS 13](https://nextjs.org/) and [Typescript](https://www.typescriptlang.org/).\n```bash\nnpm run dev # Runs vizualizer in development mode.\n```\nSee [NextJS docs](https://nextjs.org/docs) for more information.\n\n#### Updating grpc client code\n`generateTSDecoders.sh` generates grpc client code in `src/grpcjs/proto/v1alpha` based on the proto definitions in `tierkreis/protos/v1alpha`. The grpc client code is used to deserialize incoming tierkreis `Graph`, `TypeErrors` and `OutputStream` binaries.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcqcl%2Ftierkreis-viz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcqcl%2Ftierkreis-viz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcqcl%2Ftierkreis-viz/lists"}