forked from sarchlab/akita
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
19 changed files
with
36,630 additions
and
460 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,3 +18,7 @@ debug | |
|
||
# Prof file | ||
*.prof | ||
|
||
.DS_Store | ||
|
||
.vscode/*.log |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,18 @@ | ||
# Akita Monitoring Tool | ||
|
||
Akita Monitoring Tool is a toolset allow user to monitor the simulation status during the simulation is running. It also provides simple solutions that users to interact with the simulation. | ||
Akita Monitoring Tool is a tool that allows users to monitor the simulation status while the simulation is running. It also provides simple solutions for users to control the running simulation. | ||
|
||
## Use | ||
|
||
If you want to develop a simulator and want it to support real-time monitoring, you can initiate the monitor in your configuration code. You also need to register the simulator engine with the `RegisterEngine` function of the `Monitor` struct and all the components that you want to monitor with the `RegisterComponent` function of the`Monitor` struct. | ||
If you want to develop a simulator that supports real-time monitoring, you can initiate the monitor in your configuration code. You also need to register the simulator engine with the `RegisterEngine` function of the `Monitor` struct. Also, you need to register all the components that you want to monitor with the `RegisterComponent` function of the `Monitor` struct. | ||
|
||
Before the simulation starts, call the `StartServer` function of the monitor. A web server will be hosted and the port will be printed to standard output. | ||
Before the simulation starts, call the `StartServer` function of the monitor. A web server will be hosted and the port will be printed to standard error output. | ||
|
||
You can use a web browser to access the monitoring tool hosted at the given port. | ||
|
||
## Develop | ||
## Development | ||
|
||
1. Make sure you have NodeJS and npm installed. | ||
2. In the web folder, type `npm install` to install dependencies. | ||
3. In the web folder, run `npm run watch` to use webpack to build static assets. | ||
4. Set environment variable `AKITA_MONITOR_DEV` to the `true` to enable the development. In development mode, your modification to the frontend code will be reflected without recompiling the simulation. | ||
3. In the web folder, run `npm run watch` to use Webpack to build static assets. | ||
4. Set environment variable `AKITA_MONITOR_DEV` to the `true` to enable the development mode. In development mode, your modification to the frontend code will be reflected without recompiling the simulation. |
Oops, something went wrong.