Skip to content

Commit df62be2

Browse files
Modified table of contents & completed initial content for Setup Section (#266)
1 parent f5dd78a commit df62be2

13 files changed

+149
-7
lines changed

docs/source/user_guide/FPGA_index.rst

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
=============
2+
FPGA Input
3+
=============
4+
5+
This section will document FPGA input for Rapid Power Estimator.
6+
7+
Clocking
8+
#########
9+
10+
.. image:: figures/FPGA-figures-clocking-input_clock_info.JPG
11+
:width: 300px
12+
:align: center
13+
:height: 350px
14+
:alt: Setup Diagram
15+
16+
.. image:: FPGA/figures/clocking-input_clock_info.JPG
17+
:alt: Setup Diagram
18+
:align: center
19+
20+
FLE - Functional Logic Element
21+
###############################
22+
23+
BRAM - Block Randon Access Memory
24+
##################################
25+
26+
DSP - Digital Signal Processor
27+
###############################
28+
29+
IO - Input/Output
30+
##################

docs/source/user_guide/SoC_index.rst

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
=============
2+
SoC Input
3+
=============
4+
5+
This section will document SoC input for Rapid Power Estimator.
6+
7+
Peripherals
8+
###########
9+
10+
BCPU - Boot Central Processing Unit
11+
#######################################
12+
13+
Connectivity
14+
############
15+
16+
Memory
17+
########
18+
19+
ACPU - Application Central Processing Unit
20+
###########################################
21+
22+
DMA - Direct Memory Access
23+
###########################
Loading
Loading
Loading
Loading
Loading
Loading
Loading

docs/source/user_guide/index.rst

+5-7
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,8 @@ User Guide
77
:maxdepth: 2
88
:caption: Table of Contents
99

10-
introduction
11-
setup
12-
FPGA
13-
SoC
14-
peripherals
15-
memory
16-
results
10+
introduction_index
11+
setup_index
12+
FPGA_index
13+
SoC_index
14+
results_index
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
====================
2+
Introduction to RPE
3+
====================
4+
5+
This section will document the Introduction of Rapid Power Estimator.
6+
+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
====================
2+
Analyzing Results
3+
====================
4+
5+
This section will document the results on Rapid Power Estimator.
6+
7+
FPGA Complex & Core Power
8+
#########################
9+
10+
Processing Complex (SoC) Power
11+
##############################
12+
13+
Overall Typical & Worst Case Power
14+
##################################
+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
==========================
2+
Setting up an RPE Project
3+
==========================
4+
5+
This section will document how to setup a project on Rapid Power Estimator.
6+
7+
Launching RPE
8+
##############
9+
10+
To launch the Rapid Power Estimator, simply navigate to your start menu and search for "Rapid Power Estimator". Once the application is found, click on the application icon to launch the tool.
11+
12+
.. image:: figures/setup-figures-launching_RPE_from_windows_start_menu.JPG
13+
:alt: RPE icon on windows start menu
14+
15+
The Rapid Power Estimator will display the following screen upon launch.
16+
17+
.. image:: figures/setup-figures-launch_RPE-start_screen.JPG
18+
:alt: Start screen
19+
20+
Device Selection
21+
#################
22+
23+
The first step in beginning an RPE project is to select the FPGA device, once selected this device should not be changed during the project.
24+
25+
To view the devices supported on RPE, click on the Device dropdown labelled "Select a device" on the top left of the screen.
26+
27+
.. image:: figures/setup-figures-device_selection-device_info_display.JPG
28+
:alt: Device Selection dropdown menu
29+
30+
Once a device is selected, logic density, package, spreedgrade and temperature grade range will be displayed. Check to make sure the selected device matches the one you plan to evaluate or currently are using with Raptor Design Suite.
31+
32+
.. image:: figures/setup-figures-device_selection-MPW1_device_info.JPG
33+
34+
Project Creation
35+
#################
36+
37+
Once a device has been selected, it is reccommended to save the project before continuing. To save your work as a .rpe project, simply click the "file" tab on the top left of the window and click the "save as" option.
38+
39+
.. image:: figures/setup-figures-project_creation-file_save_as.JPG
40+
:width: 260px
41+
:height: 320px
42+
:alt: save as option
43+
44+
45+
A window will be opened prompting the user to select a location to save the RPE project as well as provide a name for the project. After setting the location and name, click "Save Project Folder"
46+
47+
.. image:: figures/setup-figures-project_creation-create_project_folder.JPG
48+
:alt: save project folder
49+
50+
While working on the RPE project, the user can save their project's progress using either the save option under the file tab or the floppy disk save icon found above the FPGA Complex and Core Power display.
51+
52+
.. image:: figures/setup-figures-project_creation-file_save.JPG
53+
:alt: save option
54+
55+
.. image:: figures/setup-figures-project_creation-file_save_icon.JPG
56+
:alt: save icon
57+
58+
In order to open an RPE project after closing and re-launching Raptor, the user should click the file tab and click on "Open Project"
59+
60+
.. image:: figures/setup-figures-project_creation-open_project_option.JPG
61+
:alt: open project option
62+
63+
.. image:: figures/setup-figures-project_creation-open_project.JPG
64+
:alt: open project
65+
66+
The user will find their RPE project folder and inside find the .rpe project file.
67+
68+
.. image:: figures/setup-figures-project_creation-open_project_file.JPG
69+
:alt: open project file
70+
71+
Select the project file, then click the open button on the window to open the project and continue working from where you left off.

0 commit comments

Comments
 (0)