You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
64 lines
2.1 KiB
Markdown
64 lines
2.1 KiB
Markdown
# FRMS
|
|
|
|
## ForeLight Reactor Management System
|
|
|
|
This branch will serve as the staging ground for adding unit tests and documentation in order to finalize v0.1.0-alpha
|
|
|
|
## Table of Contents
|
|
|
|
* [Introduction](#introduction)
|
|
* [Getting Started](#getting-started)
|
|
* [Installation](#installation)
|
|
* [Usage](#usage)
|
|
* [Wiki](wiki/wiki.md)
|
|
* [Overview](wiki/wiki.md#overview)
|
|
* [Server](wiki/server.md)
|
|
* [Reactor](wiki/reactor.md)
|
|
* [Hardware](wiki/reactor.md#hardware)
|
|
* [Networking](wiki/networking.md)
|
|
* [GUI](wiki/gui.md)
|
|
* [API](wiki/api.md)
|
|
* [Future Work](wiki/future-work.md)
|
|
|
|
## Introduction
|
|
|
|
FRMS serves as both an internal framework for testing reactor designs as well as a scalable customer facing application for monitoring and control.
|
|
The project makes heavy use of low-cost yet powerful embedded systems capable of running full Linux kernels.
|
|
Examples include the [BeagleBone Black](https://beagleboard.org/black) which was heavily used in development of FRMS as well as the popular [Raspberry Pi 4](https://www.raspberrypi.com/products/raspberry-pi-4-model-b/).
|
|
For more information about the hardware used in the reactors see [here](wiki/reactor.md#hardware).
|
|
|
|
In its current state, FRMS is very bare bones and exists mostly as a proof of concept.
|
|
Quickly navigate to:
|
|
- [Getting started](#getting-started)
|
|
- [Improving the project](wiki/future-work.md)
|
|
- [More information](wiki/wiki.md)
|
|
- [Bugs/questions](https://github.com/fl-src/FRMS/issues/new)
|
|
|
|
## Getting Started
|
|
|
|
### Development
|
|
|
|
FRMS was initially written almost entirely in [Go](https://go.dev/) with some bash/python helper scripts.
|
|
Go was used primarily for its emphasis on readable and maintainable code as well as its approach to concurrent applications.
|
|
Creating software capable of scaling up to many reactors made heavy use of [Goroutines](https://go.dev/tour/concurrency/1) especially on the server.
|
|
To begin developing use `git clone git@github.com:fl-src/FRMS.git` to clone the repository.
|
|
|
|
### Installation
|
|
|
|
### Usage
|
|
|
|
## Technical Information
|
|
|
|
### Overview
|
|
|
|
### Reactor
|
|
|
|
### Networking
|
|
|
|
### GUI
|
|
|
|
### API
|
|
|
|
### Future Work
|
|
|