Skip to content

Commit ef63b9f

Browse files
committed
adding some beginner content for the RPE doc
1 parent fb6eb13 commit ef63b9f

File tree

1 file changed

+28
-5
lines changed

1 file changed

+28
-5
lines changed

docs/source/index.rst

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,39 @@
1-
.. Rapid Power Estimator documentation master file, created by
2-
sphinx-quickstart on Wed Oct 16 11:21:57 2024.
3-
You can adapt this file completely to your liking, but it should at least
4-
contain the root `toctree` directive.
5-
61
Welcome to Rapid Power Estimator's Documentation!
72
=================================================
83

4+
Introduction
5+
============
6+
7+
Power and thermal specifications are critical considerations in the early stages of designing SoCs and FPGAs. Determining accurate power requirements and cooling solutions is essential to avoid over-designing or under-designing your product's power and thermal systems. It is a valuable tool in this process.
8+
9+
RPE allows you to estimate power consumption at various stages of your design cycle. It simplifies the input of design information through intuitive wizards and delivers comprehensive power and thermal data analysis.
10+
11+
History
12+
=======
13+
14+
The Power Estimator tool was first designed and developed by Brian (who has since left the company) using an Excel spreadsheet. Over time, the Excel sheet's design became slower and more cumbersome as development progressed, with an increasing number of macros, functions, and data being added to the spreadsheet. This negatively impacted scalability and long-term maintenance.
15+
16+
GUI Design and Technology Choices
17+
=================================
18+
19+
To craft an aesthetically pleasing and contemporary GUI, leveraging web technologies like HTML and CSS is a fitting choice for the design. While web technologies are a tried-and-true tech stack with cross-platform compatibility across Windows, Linux, and macOS, there are certain considerations to keep in mind. One significant challenge is that the software engineers within the company may not possess expertise in web technologies like HTML, CSS, and JavaScript.
20+
21+
Furthermore, the internet offers a plethora of free software frameworks, including Electron.js, React.js, Angular.js, Vue.js, etc., each boasting its strengths and weaknesses. This wide array of choices necessitates a careful evaluation of which framework aligns best with our project goals.
22+
23+
On the backend side, we have a range of options, such as C#.NET, Python, Node.js, and C++, offering flexibility in crafting the backend architecture. Exploring these possibilities and determining how to seamlessly integrate frontend and backend components is a critical aspect of our project.
24+
25+
The importance of a proof of concept cannot be overstated. It serves as a crucial milestone to ensure that our software not only functions as intended but is also prepared for production deployment. During this phase, we can assess the suitability of our chosen technologies, validate the frontend-backend connection, and verify that our software is ready for real-world use.
26+
27+
Contents
28+
========
29+
930
.. toctree::
1031
:maxdepth: 2
1132
:caption: Contents:
1233

1334
installation
35+
usage
36+
api_reference
1437

1538
Indices and tables
1639
==================

0 commit comments

Comments
 (0)