Merge branch 'main' into dev

Author: Biohazardyee

README.md

@@ -1 +1,116 @@
-2024-2025-project-4-web-fpga-team-4
+<p align="center"><em>What if you could visualize, simulate, and master FPGA development all in one place with...</em></p>
+<p align="center">
+  <picture><source media="(prefers-color-scheme: dark)" srcset="./documents/functional-specifications/images/logo-light.png"><source media="(prefers-color-scheme: light)" srcset="./documents/functional-specifications/images/logo-dark.png"><img alt="FPGA Explorer Logo"  style="width:100px">    </picture>
+</p>
+<p align="center">
+<a href="#features">Features</a> • 
+<a href="#manifest">Manifest</a> • 
+<a href="#prerequisites">Prerequisites</a> • 
+<a href="#configuration">Configuration</a> • 
+<a href="#json-creator">JSON Creator</a>
+</p> 
+
+<hr>
+
+**FPGA Explorer** is an interactive platform designed to simplify the exploration and learning of Field-Programmable Gate Arrays (FPGAs). Whether you're a student, teacher, or hobbyist, this tool helps you understand, develop, and simulate FPGA logic in a visual and intuitive way.
+
+👉 [**Try it online**](https://two024-2025-project-4-web-fpga-team-4.onrender.com/client.html)
+
+You can use the file example.sdf to test the application.
+
+You can also upload your own `.sdf` files to visualize and simulate them.
+
+# Features
+
+- **Visual Logic Simulation**  
+  Simulate FPGA circuits in real time and watch how data flows through flip-flops, LUTs, and wires—perfect for exploring internal chip behavior.
+
+- **Educational Focus**  
+  Designed for learning, FPGA Explorer makes it easy to understand digital logic by visualizing how components interact, step by step.
+
+- **Pivot Format**  
+  Upload `.sdf` files and watch them automatically parsed into a structured JSON format designed for clarity and modularity.  
+  You can download the generated JSON, tweak it, and re-upload it to create your own examples effortlessly.
+
+
+# Manifest
+
+- [Functional Specifications](./documents/functional-specifications/functional-specifications.md)
+- [Technical Specifications](./documents/technical-specifications/technical-specifications.md)
+- [Test Plan](./documents/quality-assurance/test-plan.md)
+- [User Manual](./documents/user-manual/user-manual.pdf)
+- [Management Artifacts](./documents/management/management-artifact.md)
+- [Source Code](./src/)
+- [SDF Example](./documents/user-manual/example.sdf)
+- [JSON Creator](./src/json_creator/json-creator.py)
+
+# Prerequisites
+
+- Node.js (v14 or later)
+- npm (Node Package Manager)
+- Python 3.x (for JSON Creator)
+
+# Configuration
+
+1. Clone the repository
+```bash
+git clone https://github.com/algosup/2024-2025-project-4-web-fpga-team-4.git
+```
+2. Navigate to the directory
+```bash
+cd 2024-2025-project-4-web-fpga-team-4/src
+```
+3. Start the application
+```bash
+npm install
+npm start
+```
+
+The interface will open in your browser at http://localhost:8080/code/client.html.
+
+# JSON Creator
+
+FPGA Explorer includes a **command-line script** to help users generate custom `.json` files without writing them from scratch. This is ideal for testing small examples or building circuits manually.
+
+> ⚠️ Note: This tool is **optional** and not the main feature of the platform.
+
+## Run the Script
+
+```bash
+/opt/homebrew/bin/python3 ./src/json_creator/json-creator.py
+```
+
+It will guide you step by step through:
+- Adding **LUTs**, **Flip-Flops**, and **I/Os**
+- Creating **connections** with timing delays
+- Saving everything into a valid `output.json` file
+
+You can upload the generated file directly into FPGA Explorer to simulate your custom circuit.
+
+## Important Notes
+- **Case sensitive**: Use correct casing for element types (`LUT`, `FlipFlop`, `IO`)
+- **Unique IDs**: Required for LUTs and Flip-Flops
+- **Valid timing**: Must be a numeric value
+- **I/Os use names** instead of numeric IDs
+
+<!-- # Known Bugs
+
+- [ ] Add a list of known bugs here -->
+
+# Contributing
+We welcome contributions! Feel free to submit issues, suggest new features, or open pull requests.
+
+# License
+[MIT License](./LICENSE.md)
+
+# Authors
+
+Made with ❤️ by Team 4
+
+- [**Thibaud Marlier**](https://www.linkedin.com/in/thibaudmarlier/) – Project Manager  
+- [**Maxime Caron**](https://www.linkedin.com/in/maxime-caron-dev/) – Program Manager  
+- [**Emilien Chinsy**](https://www.linkedin.com/in/emilien-chinsy-5a794632b/) – Technical Lead  
+- [**Guillaume Despaux**](https://www.linkedin.com/in/guillaume-despaux/) – Quality Assurance  
+- [**Clémentine Curel**](https://www.linkedin.com/in/clementinecurel/) – Technical Writer  
+- [**Jason Grosso**](https://www.linkedin.com/in/jason-grosso-847b39251/) – Software Engineer  
+- [**Laurent Bouquin**](https://www.linkedin.com/in/laurentb22/) – Software Engineer  

documents/management/communication/communication-artifact.md

@@ -16,6 +16,10 @@
     - [**3rd Response**](#3rd-response)
     - [**4th Message**](#4th-message)
     - [**4th Response**](#4th-response)
+    - [**Functional Specifications Review**](#functional-specifications-review)
+      - [**Response**](#response)
+    - [**Technical Specifications Review**](#technical-specifications-review)
+    - [**User Manual Review**](#user-manual-review)
 
 ## Introduction
 
@@ -208,4 +212,44 @@ Best Regard.
 
 Hi, this is related to the way the tool is handling reset ( to be true it doesn't handle flipflop with reset). \
 So instead of connecting the reset signal to the reset pin of the flipflop it tries to connect the reset on input signals. \
-You should only consider examples without reset in it. It is easier to understand.
+You should only consider examples without reset in it. It is easier to understand.
+
+---
+
+### **Functional Specifications Review**
+
+![alt text](./images/review-functional1.png)
+
+- there is a lite free version of xilinx vivado also
+
+- 2.2. User Personas => you should remove this chapter (these are not real cnes people and can confuse) .Your if you want to keep your profile remove CNES name eveyrwhere
+
+- The sdf can be uplodaed but there won't be any prerequisite about it. Your server should come with a preloaded sdf file so simulation can be run without any extra file
+
+![alt text](./images/review-functional2.png)
+
+- the clock component is an input and should be on the left (probably below the I/O)
+
+![alt text](./images/review-functional3.png)
+
+- You cannot render the example strucutre wiht sdf file . this is just a timing format, you need verilog file to create the structure
+
+Otherwise no other remark
+
+Link to the whole discussion: [Click Here](https://github.com/LeFl0w/ALGOSUP_POC/issues/12)
+
+#### **Response**
+
+Hello Florent,
+
+Thank you for your feedbacks, I'll correct the document to fit with them during the week.
+
+Kindly.
+
+Caron Maxime \
+Program Manager \
+Team 4
+
+### **Technical Specifications Review**
+
+### **User Manual Review**

documents/management/communication/images/review-functional1.png

@@ -2,7 +2,15 @@
 
 ## **Overview**
 
-## **Week 4 Objectives**
+This was the final week with allocated project time before the deadline. The team had significant time to work on the project, leading to major progress in both documentation and code. The primary goal was to finalize all essential documents and refine the web interface.
+
+## **Week 5 Objectives**
+
+- **Complete the Technical Specifications document**
+- **Finalize the Test Plan document**
+- **Publish the Test Plan and Technical Specifications documents**
+- **Implement animations in the web interface**
+- **Make significant progress on the User Manual**
 
 ## **Team Feedback**
 
@@ -27,8 +35,54 @@ The team was asked to rate their experience for the week based on the following
 
 ### **Survey Results**
 
+![alt text](./images/kpis-week5.png)
+
+The team’s morale significantly improved this week. This was due to the substantial project time available, which allowed for considerable progress. Both the **Technical Specifications** and **Test Plan** documents were completed and published.
+
+Additionally, the positive atmosphere among team members contributed to an overall sense of accomplishment.
+
+You can find a more detailed breakdown following this link: [Link to week's 5 KPIs](https://docs.google.com/spreadsheets/d/1EJIGbOufF86FP-Pb6Y5z0wuYymK0fEmoFKtg16JfIHg/edit?usp=sharing)
+
 ## **Project Progress**
 
+- **Technical Specifications Document**
+
+  - Finalized and published
+  - Sent for client review
+
+- **Test Plan**
+
+  - Finalized and published
+
+- **User Manual**
+
+  - Reached 90% completion
+  - First version published
+
+- **Web Interface**
+
+  - One animation implemented, but it does not yet function in real-time or accurately represent live data
+
+- **Final Presentation**
+  - The team attended a preparation session for the final presentation
+  - Progress on the presentation was minimal due to this session
+
 ## **Challenges**
 
+- **Formatting Issues in the Technical Specifications Document**
+
+  - Code blocks and formatting were disrupted during spell-checking and finalization
+  - Immediate corrections were required before publication
+
+- **Web Interface Timing Issues**
+  - The animation does not accurately display the concurrent propagation of electrical signals
+  - No further improvements will be made due to lack of allocated project time before the final deadline
+
 ## **Next Week Plans**
+
+- **Prepare the oral presentation**
+- **Finalize and publish the User Manual**
+- **Write and format the README file**
+- **Final refactoring and code documentation (overtime hours if necessary)**
+- **Deliver the final presentation**
+- **Conduct a post-mortem analysis of the project**

documents/management/communication/images/review-functional2.png

@@ -2,7 +2,7 @@
 
 ## **Overview**
 
-## **Week 4 Objectives**
+## **Week 6 Objectives**
 
 ## **Team Feedback**
 

documents/management/communication/images/review-functional3.png

@@ -43,6 +43,15 @@
   - [**Project Progress**](#project-progress-3)
   - [**Challenges**](#challenges-3)
   - [**Next Week Plans**](#next-week-plans-3)
+- [**Weekly Report 5**](#weekly-report-5)
+  - [**Overview**](#overview-4)
+  - [**Week 5 Objectives**](#week-5-objectives)
+  - [**Team Feedback**](#team-feedback-4)
+    - [**Survey Questions**](#survey-questions-4)
+    - [**Survey Results**](#survey-results-4)
+  - [**Project Progress**](#project-progress-4)
+  - [**Challenges**](#challenges-4)
+  - [**Next Week Plans**](#next-week-plans-4)
 
 </details>
 
@@ -412,3 +421,94 @@ More details on the satisfaction survey can be found [here.](https://docs.google
 - **Publish the Test Plan and the Technical Specifications documents**
 - **Implement animations in the web interface**
 - **Make significant progress on the User Manual**
+
+---
+
+# **Weekly Report 5**
+
+## **Overview**
+
+This was the final week with allocated project time before the deadline. The team had significant time to work on the project, leading to major progress in both documentation and code. The primary goal was to finalize all essential documents and refine the web interface.
+
+## **Week 5 Objectives**
+
+- **Complete the Technical Specifications document**
+- **Finalize the Test Plan document**
+- **Publish the Test Plan and Technical Specifications documents**
+- **Implement animations in the web interface**
+- **Make significant progress on the User Manual**
+
+## **Team Feedback**
+
+### **Survey Questions**
+
+The team was asked to rate their experience for the week based on the following questions:
+
+- **How satisfied are you with this week? (Rate from 1 to 5)**
+
+  - 1 - Very Unsatisfied
+  - 2 - Unsatisfied
+  - 3 - Neutral
+  - 4 - Satisfied
+  - 5 - Very Satisfied
+
+- **How would you rate the team's collaboration this week? (Rate from 1 to 5)**
+  - 1 - Very Poor
+  - 2 - Poor
+  - 3 - Average
+  - 4 - Good
+  - 5 - Excellent
+
+### **Survey Results**
+
+![alt text](./images/kpis-week5.png)
+
+The team’s morale significantly improved this week. This was due to the substantial project time available, which allowed for considerable progress. Both the **Technical Specifications** and **Test Plan** documents were completed and published.
+
+Additionally, the positive atmosphere among team members contributed to an overall sense of accomplishment.
+
+You can find a more detailed breakdown following this link: [Link to week's 5 KPIs](https://docs.google.com/spreadsheets/d/1EJIGbOufF86FP-Pb6Y5z0wuYymK0fEmoFKtg16JfIHg/edit?usp=sharing)
+
+## **Project Progress**
+
+- **Technical Specifications Document**
+
+  - Finalized and published
+  - Sent for client review
+
+- **Test Plan**
+
+  - Finalized and published
+
+- **User Manual**
+
+  - Reached 90% completion
+  - First version published
+
+- **Web Interface**
+
+  - One animation implemented, but it does not yet function in real-time or accurately represent live data
+
+- **Final Presentation**
+  - The team attended a preparation session for the final presentation
+  - Progress on the presentation was minimal due to this session
+
+## **Challenges**
+
+- **Formatting Issues in the Technical Specifications Document**
+
+  - Code blocks and formatting were disrupted during spell-checking and finalization
+  - Immediate corrections were required before publication
+
+- **Web Interface Timing Issues**
+  - The animation does not accurately display the concurrent propagation of electrical signals
+  - No further improvements will be made due to lack of allocated project time before the final deadline
+
+## **Next Week Plans**
+
+- **Prepare the oral presentation**
+- **Finalize and publish the User Manual**
+- **Write and format the README file**
+- **Final refactoring and code documentation (overtime hours if necessary)**
+- **Deliver the final presentation**
+- **Conduct a post-mortem analysis of the project**