Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/homotopy-io/homotopy-rs
A Rust/WASM implementation of homotopy.io
https://github.com/homotopy-io/homotopy-rs
category-theory diagram diagrams higher-category-theory math mathematics maths proof-assistant proof-assistants rust string-diagram string-diagrams
Last synced: about 1 month ago
JSON representation
A Rust/WASM implementation of homotopy.io
- Host: GitHub
- URL: https://github.com/homotopy-io/homotopy-rs
- Owner: homotopy-io
- License: bsd-3-clause
- Created: 2020-09-17T10:01:55.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-21T22:35:42.000Z (about 1 month ago)
- Last Synced: 2024-05-22T00:52:36.573Z (about 1 month ago)
- Topics: category-theory, diagram, diagrams, higher-category-theory, math, mathematics, maths, proof-assistant, proof-assistants, rust, string-diagram, string-diagrams
- Language: Rust
- Homepage: https://homotopy.io
- Size: 212 MB
- Stars: 73
- Watchers: 6
- Forks: 5
- Open Issues: 94
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-rust-formalized-reasoning - homotopy-rs - implementation of homotopy.io proof assistant. (Projects / Provers and Solvers)
README
# About the project
The homotopy.io proof assistant allows the construction of composite morphisms in a finitely-generated semistrict n-category, via a point-and-click user interface. Composites are rendered as 2d and 3d geometries, and can be visualised in 4d as movies of 3d geometries. Beyond its features as a visual proof assistant, homotopy.io can also be used as an effective tool to typeset string diagrams: any 2d diagram constructed in the proof assistant can be exported with ease into LaTeX/TikZ and SVG, with experimental support for manim.
The proof assistant is implemented in the Rust programming language, and compiled to WebAssembly to run in the web browser.
For a description of how the tool works, please see the [arXiv paper](https://arxiv.org/abs/2402.13179) or [nLab page](https://ncatlab.org/nlab/show/homotopy.io). A more recent tutorial may be found [here](./TUTORIAL.md).
The master branch is hosted live here: https://beta.homotopy.io/
# Developing
The easiest way to set up a development environment is with [Nix](https://nixos.org/).
Running
```
nix develop github:homotopy-io/homotopy-rs
```
will spawn a development shell with Rust, and all the necessary tooling required to build the project. Additionally, this is the exact same environment that the CI uses, so providing that it is passing, this cannot fail:
Any recent commit can be run with
```
nix run github:homotopy-io/homotopy-rs?rev=X
```
Please adhere to Rust stable and lint all code with `nix run github:homotopy-io/homotopy-rs#lint`.
## Development server
From the root of the project, run `cargo make serve`. This will build the app into `/dist`, and concurrently run a development server on http://localhost:5000, which refreshes whenever the code changes.
Alternatively, the project can be built with `nix build`, with the development server invoked by `sfz -r result/`, where `result/` is the nix-build output folder.
## Nix & GitHub Actions
This project uses GitHub Actions CI, for automating builds, testing, and deployment. GitHub Actions uses Nix to build, and the resulting compilation artifacts should like-for-like match those generated by `nix-build`. In particular, this allows binary artifacts (including witnesses of tests being run!) to be substituted across machines, in the standard way supported by Nix. Nix builds are cached on [Cachix](https://app.cachix.org/cache/homotopy-io). In other words, `nix-build | cachix push homotopy-io` allows the CI to skip compilation and test running.
Dependencies are updated via [Dependabot](https://github.com/dependabot), and are automatically merged (provided that all tests pass).
Keep the Cargo.lock updated with any changes to the various Cargo.toml, e.g. by running `cargo check` inside a dev-shell, as not doing so may cause problems with the build.
## Firebase
Builds are deployed to Firebase for hosting, by the GitHub Actions CI. https://beta.homotopy.io mirrors `master`, and any pull request generates a [Firebase Hosting preview](https://firebase.google.com/docs/hosting/test-preview-deploy#preview-channels) site, of the form homotopy-rs--homotopy-io-X.web.app.
In future, Firebase will also act as online storage for user projects.
# Citing
The tool should be cited as follows:
```
@article{hio,
title={homotopy.io: a proof assistant for finitely-presented globular $n$-categories},
author={Corbyn, Nathan and Heidemann, Lukas and Hu, Nick and Sarti, Chiara and Tataru, Calin and Vicary, Jamie},
journal={arXiv preprint arXiv:2402.13179},
year={2024}
}
```
# License
Unless explicitly stated otherwise, all contributions are licensed under the following terms.
## Source
homotopy.io source code is published under the terms of the [BSD 3-Clause License](LICENSE).
## Documentation
homotopy.io documentation is licensed under a Creative Commons Attribution 4.0 International License.
## Dependencies
We use the HiGHS linear programming solver for the layout algorithm:
Parallelizing the dual revised simplex method, Q. Huangfu and J. A. J. Hall, Mathematical Programming Computation, 10 (1), 119-142, 2018. DOI: 10.1007/s12532-017-0130-5
We use the [keyboard-css](https://github.com/shhdharmen/keyboard-css) library.