more docs

docs/Simulation/Commercial-Simulators.rst

@@ -0,0 +1,33 @@
+Commericial Simulators
+==============================
+The ReBAR framework currently supports only the VCS commerical simulator
+
+VCS
+-----------------------
+VCS is a commercial RTL simulator developed by Synopsys. It requires commerical licenses.
+The ReBAR framework can compile and execute simulations using VCS. VCS simulation will generally compile
+faster than Verilator simulations.
+
+To run a simulation using VCS, perform the following steps:
+
+Make sure that the VCS simulator is on your `PATH`.
+
+To compile the example design, run make in the ``sims/vsim`` directory.
+This will elaborate the DefaultExampleConfig in the example project.
+
+An executable called simulator-example-DefaultExampleConfig will be produced.
+This executable is a simulator that has been compiled based on the design that was built.
+You can then use this executable to run any compatible RV64 code. For instance,
+to run one of the riscv-tools assembly tests.
+
+::
+    ./simulator-example-DefaultExampleConfig $RISCV/riscv64-unknown-elf/share/riscv-tests/isa/rv64ui-p-simple
+
+If you later create your own project, you can use environment variables to
+build an alternate configuration.
+
+::
+    make PROJECT=yourproject CONFIG=YourConfig
+    ./simulator-yourproject-YourConfig ...
+
+If you would like to extract waveforms from the simulation, run the command ``make debug`` instead of just ``make``. This will generate a vpd file (this is a proprietry waveform representation format used by Synopsys) that can be loaded to vpd-supported waveform viewers. If you have Synopsys licenses, we recommend using the DVE waveform viewers

docs/Simulation/FPGA-Based-Simulators.rst

@@ -0,0 +1,13 @@
+FPGA-Based Simulators
+==============================
+
+FireSim
+-----------------------
+FireSim is an open-source cycle-accurate FPGA-accelerated full-system hardware simulation platform that runs on cloud FPGAs (Amazon EC2 F1).
+FireSim allows RTL-level simulation at orders-of-magnitude faster speeds than software RTL simulators. FireSim also provide additional device models to allow full-system simulation, including memory models and network models.
+
+FireSim currently supports running only on Amazon EC2 F1 FPGA-enabled virtual instances on the public cloud. In order to simulate your ReBAR design using FireSim, you should follow the following steps:
+
+Follow the initial EC2 setup instructions as detailed in the FireSim documentatino <link>. Then clone your full ReBAR repository onto your Amazon EC2 FireSim manager instance.
+
+Enter the ``sims/FireSim`` directory, and follow the FireSim instructions for running a simulation <link>

docs/Simulation/Open-Source-Simulators.rst

@@ -0,0 +1,33 @@
+Open Source Simulators
+==============================
+
+Verilator
+-----------------------
+Verilator is an open-source LGPL-Licensed simulator maintained by `Veripool <https://www.veripool.org/>`__
+The ReBAR framework can download, build, and execute simulations using Verilator.
+
+To run a simulation using verilator, perform the following steps:
+
+To compile the example design, run make in the ``sims/verisim`` directory.
+This will elaborate the DefaultExampleConfig in the example project.
+
+An executable called simulator-example-DefaultExampleConfig will be produced.
+This executable is a simulator that has been compiled based on the design that was built.
+You can then use this executable to run any compatible RV64 code. For instance,
+to run one of the riscv-tools assembly tests.
+
+::
+    ./simulator-example-DefaultExampleConfig $RISCV/riscv64-unknown-elf/share/riscv-tests/isa/rv64ui-p-simple
+
+If you later create your own project, you can use environment variables to
+build an alternate configuration.
+
+::
+    make PROJECT=yourproject CONFIG=YourConfig
+    ./simulator-yourproject-YourConfig ...
+
+
+If you would like to extract waveforms from the simulation, run the command ``make debug`` instead of just ``make``. This will generate a vcd file (vcd is a standard waveform representation file format) that can be loaded to any common waveform viewer. An open-source vcd-capable waveform viewer is `GTKWave <http://gtkwave.sourceforge.net/>__ 
+
+
+