https://github.com/bring-shrubbery/liverpool-dissertation

Simulink in the browser (almost)
https://github.com/bring-shrubbery/liverpool-dissertation

education signal-processing signals visualisation

Last synced: 13 days ago
JSON representation

Simulink in the browser (almost)

• Host: GitHub
• URL: https://github.com/bring-shrubbery/liverpool-dissertation
• Owner: bring-shrubbery
• Created: 2018-10-31T10:24:52.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2023-03-02T13:33:29.000Z (over 1 year ago)
• Last Synced: 2024-05-02T05:06:44.555Z (7 months ago)
• Topics: education, signal-processing, signals, visualisation
• Language: JavaScript
• Homepage: https://liverpool.antoni.ai/projects/admin
• Size: 15.1 MB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Educational Signal Visualisation Toolbox

- DEMO: https://liverpool.antoni.ai/projects/admin

- DOCS: https://antoni-silvestrovic.gitbook.io/workspace/

## Description

Visualisation of the mathematical concepts is not an easy task. Although many visualisations were created and are being used, they were created with tools whose purpose is not the visualisation of the those concepts. As a result, you can only make one visualisation at once. And if new concept is introduced, it's often required to create it from scratch. This project is an attpemt to simplify signal visualisation for educational purposes.

## Prerequisites

To run this project you will need **Node.js** on your machine.

You can get it from [here](https://nodejs.org/en/).

## Installation

To get your hand on the source code of the project you have to clone it from the github:

`git clone https://github.com/vincentrodriguez/signals-visualisation.git`

Before you can run it you have to intall dependencies:

`npm install`

After installing dependencies you can either run it as a local server:

`npm run server`

or build it into static files:

`npm run build`

## Usage

If you run this app as a server, then you just need to visit localhost on port 3000. To do that, go to the browser and type `http://localhost:3000/` into the address bar.

If you're building the project into static files, then you'll need to host your own server. If you want to host those files locally you can use `serve` tool from npm.

Run `npm install -g serve` in your command line, go to the root directory of the project and type `serve ./build`. This will host 

## Contributing

Contributions are welcome. You can learn more about contributing on the [wiki page](https://github.com/vincentrodriguez/signals-visualisation/wiki/Contributing).

## Credits

This project was originally created by [Antoni Silvestrovic](https://github.com/vincentrodriguez).

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details