If you do not have VS Code on your machine, you can install it first, and then configure the remote access.
-
Install VS Code
-
Install necessary extensions: (When you install ‘Remote – SSH’, another one will be installed automatically.)
Now we assume that you have access to the SSH.
Before using LTBVIS, please install the extension docker in the VS Code estension market.
The LTBVis is already installed in the server for the common account '/home/curentltb/ltb/ltbvis'.
- Hit
Ctrl + ~
to open the terminal window. Change path to the LTBVIS location:
cd /home/curentltb/ltball/ltbvis
- Build the LTBVIS (the environment is already there, only do this when needed):
./go.sh build
- Open tmux:
tmux
- Now you are in the tmux, run the LTBVIS:
./go.sh dev2
Then there are three panes, which are http, dime2, and control, respectively.
-
In the port panel, port 8810 should be forwarded automatically, and you need to manually forward the port 8818. Now the communication is ready, then open the web 'localhost:8810' in your browser (Chrome is recommended) and the visualization window should be there.
-
In the tmux command window, the command is already input there, just hit 'enter' and you should be able to run the example case.
-
After running, please close the program propoerly, or it will cause trouble in the next time use. (1) In the control pane, hit
Ctrl + C
and thenexit
to safely close it. (2) Then it should be switched to dime2 pane, hitCtrl + C
and thenexit
to safely close it. (3) Then it should be switched to http pane, hitCtrl + C
and thenexit
to safely close it. (4) Finally clean the docker images and tmux sessions by./go.sh clean
. (5) Remove the ports (8810 and 8818) you just forwarded.
After successfully running the visualization, you can replay the video in your browser. Before you visualize another one, remember to refresh the visualize webpage.
Trouble shooting:
-
If no visualization appears in the browser, check if the port is forwarded correctly.
-
If in the dime pane, it said: "Address already in use", you may need to delete the '/tmp/dime2' and then run the LTBVIS again.
-
If the port is already in use, you may remove those ports in the port panel and then run again.
-
If ANDES said the file does not exist, check the mounting path. The default path is '
pwd
/cases' ('/home/curentltb/ltball/ltbvis/cases'), if you need to change the path, please change the path before ':/home/cui/work' in thedocker run ...
. It should be noted that the blank space in the path may cause error, if so please include your path in the double quote.
Other ANDES command:
If you need any other ADNES command, just modify the andes part in the docker command (... andes run wecc_vis.xlsx -r tds ...
).
Convert the andes output npz file into csv file:
andes plot weec_vis_out.npz --to-csv
Visualize the existing output csv file:
andes run weec_vis_out.xlsx --from-csv weec_vis_out.csv
More details:
ANDES Documentation:
https://docs.andes.app/en/stable/
LTBVIS:
https://github.com/CURENT/ltbvis
Play with Jupyter Notebook:
-
Open in VS Code: (Make sure you have installed Jupyter extension.)
-
Open in browser:
b) CD to the path which will be the root path:
c) open jupyter notebook by:
jupyter notebook
If it does not open browser automatically, you can open it manually from the link:
If you cannot find the desired kernel (usually it should be
andes
), you will need to install ipykernel.