dyc3 / sys-581-group-project

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Mars Communication, Command, and Control (C3) Architecture

This repository contains the source code a document describing a hypothetical Mars Communication, Command, and Control (C3) architecture. The document is written in typst, and was created as a group project for SYS 581 Intro to Systems course at Stevens Institute of Technology.

Setup

  1. Install typst
  2. Install mermaid-cli (requires node.js)
npm install -g @mermaid-js/mermaid-cli@10.6.1

Note: Running in WSL may require some additional setup for mermaid to work. See: https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md#running-puppeteer-on-wsl-windows-subsystem-for-linux

Usage

if you have just installed, you can run these:

# build the document
just build

# rerender all figures
just figures

# build the document in watch mode (rebuilds on file changes)
just watch

if you have make installed, you can run these:

# build the document
make

# rerender all figures
make figures

Otherwise, you can run the commands in the makefile manually.

# produces main.pdf
typst compile main.typ

# rerenders all figures
./scripts/render-figures.sh

About

License:The Unlicense


Languages

Language:Jupyter Notebook 97.8%Language:Typst 1.7%Language:TeX 0.2%Language:Mermaid 0.1%Language:Shell 0.1%Language:Cap'n Proto 0.0%Language:Just 0.0%Language:Makefile 0.0%