# emulsiV

**Repository Path**: jinghang/emulsiV

## Basic Information

- **Project Name**: emulsiV
- **Description**: A visual simulator for teaching computer architecture using the RISC-V instruction set
- **Primary Language**: NodeJS
- **License**: MPL-2.0
- **Default Branch**: master
- **Homepage**: https://eseo-tech.github.io/emulsiV/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-11-05
- **Last Updated**: 2024-11-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


emulsiV
==========

[emulsiV](https://eseo-tech.github.io/emulsiV/) is a visual simulator for Virgule,
a minimal CPU core implementation based on the RISC-V architecture.
This simulator is intended to be used as a tool for teaching the basics of
computer architecture.

The user interface shows the structure of the datapath and animates the data
transfers between functional units.
The execution of a single instruction is decomposed into several steps (fetch,
decode, ALU, mem/reg, PC) for educational reasons, but the intent is not to
reflect a specific sequencer or pipeline implementation.
In fact, we don't plan to simulate a pipeline in more detail.

emulsiV is free software and is distributed under the terms of the
[Mozilla Public License 2.0](https://github.com/ESEO-Tech/emulsiV/blob/master/LICENSE).
It is developed by Guillaume Savaton, teacher, researcher and engineer at [ESEO](https://eseo.fr).

Running the simulator locally
-----------------------------

Due to the security policies in recent web browsers, some features will only work
if the simulator is served by a web server.
We provide facilities to automate the process.

Install `npm` and run the following command from the root of the source tree:

```
npm install
```

This command starts a local web server and opens the simulator in a web browser:

```
npm start
```

Development
-----------

Check the JavaScript source code:

```
npm run lint
```

This command starts a local web server and runs the unit tests from the `test` folder:

```
npm test
```