# ARCTK

<p align="center">
    <img src="./resources/icons/arctk.svg" width="200" height="200" />
</p>

[![crate](https://img.shields.io/crates/v/arctk.svg)](https://crates.io/crates/arctk)
[![documentation](https://docs.rs/arctk/badge.svg)](https://docs.rs/arctk)
![status](https://github.com/FreddyWordingham/arctk/actions/workflows/quick_ci.yml/badge.svg)
![status](https://github.com/FreddyWordingham/arctk/actions/workflows/full_ci.yml/badge.svg)
![minimum rustc 1.63](https://img.shields.io/badge/rustc-1.63+-red.svg)

A numerical simulation framework for physical systems.

## Quickstart

Clone the repository and set the current working directory to the top level `arctk` folder:

```sh
git clone git@github.com:FreddyWordingham/arctk.git
cd arctk
```

and then install the library:

```sh
cargo install --path . --release
```

## ARCTK in the wild

`arctk` is a collection of classes that form the simulation framework for other projects:

-   [Antler](https://github.com/FreddyWordingham/antler) - A textureless rendering engine
-   [MCRT](https://github.com/FreddyWordingham/mcrt) - A physically accurate light dosimetry tool
-   [SOLAR](https://github.com/digiLab-Ai/solar) - A tool used to determine the expected power output of solar panels

## Modules

Sub-module dependency diagram:

```mermaid
graph TD;
    RT-->Geom;
    Geom-->Dom;
    Dom-->Parse;
    Phys;
```