Skip to content

setting_things_up

Jaromír Beneš edited this page May 6, 2026 · 2 revisions

Setting up the environment

The BEARX repositories can be set up on your computer (locally) either from within a system shell or from within Matlab. Because the latter is independent of the operating system, we will go that way.

Step 1. Open Matlab, and wwitch to a folder of your choice in which you want to keep the BEARX environment (using either the cd command or the path bar at the top of the Matlab IDE).

Step 2. Clone the BEARX Toolbox repository and the BEARX GUI Examples repository next to each other:

!git clone https://github.com/OGResearch/BEARX-Toolbox
!git clone https://github.com/OGResearch/BEARX-GUI-Examples

Step 3. Add the BEARX Toolbox to the Matlab path:

addpath BEARX-Toolbox -end; bearPaths

Opening the GUI

Once the BEARX paths are added to Matlab, you can create your own model folder, switch to that folder, and open the GUI two different ways:

  • gui.start will create a fresh GUI environment, erasint any previous information configured by the user (e.g. the type of the BVAR model, specification of tasks that are to be executed, etc.). Any user files, including data files, are preserved.

  • gui.resume will simply open an existing session where the user left it previously.

Opening a GUI example

Switch to the BEARX GUI example folder of your choice. We recommend starting in PlainTimeInvariant.

cd BEARX-GUI-Examples/PlainTimeInvariant

Because the BEARX GUI Examples repository comes with a certain prefilled model specification in each folder, we obviously recommed using the gui.resume command.

Follow the step-by-step guide to see how the GUI works.

Clone this wiki locally