de.uni-kl.ems.dram.vp.system
============================

Generic DRAM controller simulator and debug tools related to it.

# Basic Setup

In a terminal window execute the commands that follow (the '$' symbolizes the
terminal prompt).

Go to your home directory.

```
$ cd
```

Create a directory for your projects.

```
$ mkdir projects
```

Clone the repository.

It is possible that you will work with a **fork** of the official codebase. A
fork is a copy of a repository. In that case, after pushing changes into your
copy you should create a **pull request** in order to your supervisor check
and possibly bring your changes to the official codebase.

In case of doubts about which repository you should clone ask your supervisor.

```
$ git clone https://<user>@git.rhrk.uni-kl.de/<user>/dram.vp.system.git
```

Go to the projetct directory.

```
$ cd dram.vp.system
```

Execute the script below.

```
$ ./install_prerequisites.sh
```


## With QTCreator
Execute the *QTCreator*.

```
$ qtcreator &
```

Use the menu bar and open the DRAMSys project.

**File -> Open Project -> dram.vp.sys/dram/dramSys/dramSys.pro**

When you open the project for the first time a configuration window pops-up.
Then click in **Configure Project** and after that **Build** the project.

Repeat the procedure above and build the trace analyser project.

**File -> Open Project -> dram.vp.sys/analyser/analyser/traceAnalizer.pro**


## Without QTCreator

In case you prefer a command line interface to the QTCreator GUI you can also
use **qmake** to generate a Makefile and then compile the project.

```
$ cd dram
$ mkdir build
$ cd build
$ qmake ../dramSys/dramSys.pro
$ make
```

 
# DRAMSys Resources

The simulator's configuration is done via some files. You can find such configuration files in the directory below and its sub-directories.

```
$ cd /projects/dram.vp.system/dram/resources
```

A short description of the content each directory follows.

* resources
  * configs - XML files used for configurate specific details of the simulation.
  * scripts - useful tools.
  * simulations - global configs for simulations: debug mode, power analysis and database recording. Some specific configuration files are referenced in the global configuration file.
  * traces - trace files for simulations. They contain accesses to memory in certain known scenarios.