fix: update the project structure, components and output files

Fix footprints of some polarized components
Add 3D models for resistors, capacitors, and more
Generate the first version of the BOM, schematics, and PCB illustrations
Add bypass resistors to two power buses for testing purpose
Add specific folders for outputs and sources to organize project structure in the repository
Update the README file

.github/workflows/kibot.yml

@@ -8,15 +8,15 @@ on:
   workflow_dispatch:
   push:
     paths:
-    - "hardware/*.kicad_sch"
-    - "hardware/*.kicad_pcb"
-    - "hardware/*.kicad_pro"
+    - "sources/*.kicad_sch"
+    - "sources/*.kicad_pcb"
+    - "sources/*.kicad_pro"
     - "**/*kibot.yml"
   pull_request:
     paths:
-    - "hardware/*.kicad_sch"
-    - "hardware/*.kicad_pcb"
-    - "hardware/*.kicad_pro"
+    - "sources/*.kicad_sch"
+    - "sources/*.kicad_pcb"
+    - "sources/*.kicad_pro"
     - "**/*kibot.yml"
 
 env:
@@ -27,7 +27,7 @@ env:
 
 defaults:
   run:
-    working-directory: ./hardware
+    working-directory: ./sources
 
 jobs:
 # checks
@@ -67,9 +67,9 @@ jobs:
           name: ${{github.event.repository.name}}_docs
           if-no-files-found: error
           path: |
-            hardware/docs/**
-            !hardware/**/*.ogv
-            !hardware/**/*.log
+            outputs/docs/**
+            !outputs/**/*.ogv
+            !outputs/**/*.log
 # fabrications
   gerbers:
     runs-on: ubuntu-latest
@@ -88,9 +88,9 @@ jobs:
           name: ${{github.event.repository.name}}_gerbers
           if-no-files-found: error
           path: |
-            hardware/gerbers/**
-            !hardware/**/*.ogv
-            !hardware/**/*.log
+            outputs/gerbers/**
+            !outputs/**/*.ogv
+            !outputs/**/*.log
 # cad
   cad:
     runs-on: ubuntu-latest
@@ -109,9 +109,9 @@ jobs:
           name: ${{github.event.repository.name}}_cad
           if-no-files-found: error
           path: |
-            hardware/cad/**
-            !hardware/**/*.ogv
-            !hardware/**/*.log
+            outputs/cad/**
+            !outputs/**/*.ogv
+            !outputs/**/*.log
 # images
 #  render:
 #    runs-on: ubuntu-latest
@@ -130,6 +130,6 @@ jobs:
 #          name: ${{github.event.repository.name}}_img
 #          if-no-files-found: error
 #          path: |
-#            hardware/img/**
-#            !hardware/**/*.ogv
-#            !hardware/**/*.log
+#            outputs/img/**
+#            !outputs/**/*.ogv
+#            !outputs/**/*.log

README.md

@@ -1,56 +1,74 @@
 <h1 align="center">
-	RELIABILITY ENHANCED ELECTRICAL POWER SYSTEM
+	RELIABILITY ENHANCED ELECTRICAL POWER SYSTEM (RE²PS) HARDWARE
 	<br>
 </h1>
 
-<h4 align="center">Electrical power system module designed and developed by SpaceLab.</h4>
-
 <p align="center">
-	<a href="https://github.com/spacelab-ufsc/spacelab#versioning">
-		<img src="https://img.shields.io/badge/status-in%20development-red?style=for-the-badge">
-	</a>
-	<a href="https://github.com/spacelab-ufsc/eps-re/releases">
-		<img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/spacelab-ufsc/eps-re?style=for-the-badge">
-	</a>
-	<a href="https://github.com/spacelab-ufsc/eps-re/releases">
-		<img alt="GitHub commits since latest release (by date)" src="https://img.shields.io/github/commits-since/spacelab-ufsc/eps-re/latest?style=for-the-badge">
-	</a>
-	<a href="https://github.com/spacelab-ufsc/eps-re/commits/master">
-		<img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/spacelab-ufsc/eps-re?style=for-the-badge">
-	</a>
-	<a href="https://github.com/spacelab-ufsc/eps-re/issues">
-		<img alt="GitHub issues" src="https://img.shields.io/github/issues/spacelab-ufsc/eps-re?style=for-the-badge">
-	</a>
-	<a href="https://github.com/spacelab-ufsc/eps-re/graphs/contributors">
-		<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/spacelab-ufsc/eps-re?color=yellow&style=for-the-badge">
-	</a>
+    <a href="https://github.com/spacelab-ufsc/spacelab#versioning"><img alt="Static Badge" src="https://img.shields.io/badge/status-in_development-red"></a>
+    <a href="https://github.com/spacelab-ufsc/eps-re-hardware/releases"><img alt="GitHub Release" src="https://img.shields.io/github/v/release/spacelab-ufsc/eps-re-hardware"></a>
+    <a href="https://github.com/spacelab-ufsc/eps-re-hardware/commits/master"><img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/spacelab-ufsc/eps-re-hardware"></a>
+    <a href="https://github.com/spacelab-ufsc/eps-re-hardware/issues"><img alt="GitHub Issues or Pull Requests" src="https://img.shields.io/github/issues/spacelab-ufsc/eps-re-hardware"></a>
+    <a href="https://github.com/spacelab-ufsc/eps-re-hardware/pulls"><img alt="GitHub Issues or Pull Requests" src="https://img.shields.io/github/issues-pr/spacelab-ufsc/eps-re-hardware"></a>
+    <a href="https://github.com/spacelab-ufsc/eps-re-hardware/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/spacelab-ufsc/eps-re-hardware"></a>
 </p>
 
+<details>
+    <summary><b>Summary</b></summary>
+    <ol>
+        <li>
+            <a href="#overview">Overview</a>
+        </li>
+        <li>
+            <a href="#repository-organization">Repository Organization</a>
+        </li>
+        <li>
+            <a href="#license">License</a>
+        </li>
+        <li>
+            <a href="#releases">Releases</a>
+        </li>
+        <li>
+            <a href="#notes">Notes</a>
+        </li>
+        <li>
+            <a href="#references">References</a>
+        </li>
+    </ol>
+</details>
+
+## Overview
+The PCB of **RE²PS** [[1]](#1) was designed to be more reliable than previous EPS models developed by SpaceLab. To achieve this, ECSS standards for PCB development in space environments were tailored for the project [[2]](#2). Some flexibility was applied in selecting new connectors for interfacing with other modules, but whenever possible, previously used connectors, such as Pico-Locks and PicoBlades, were chosen.
+
 <p align="center">
-  	<a href="#overview">Overview</a> •
-  	<a href="#repository-organization">Repository Organizarion</a> •
-  	<a href="#license">License</a> •
-  	<a href="#releases">Releases</a> •
-  	<a href="#notes">Notes</a>
+    <img src="https://github.com/spacelab-ufsc/eps-re-hardware/blob/master/outputs/eps-re_2D_top.svg"><img src="https://github.com/spacelab-ufsc/eps-re-hardware/blob/master/outputs/eps-re_2D_bottom.svg">
 </p>
 
+<p align="center">
+    <img src="https://github.com/spacelab-ufsc/eps-re-hardware/blob/master/outputs/eps-re_3D_top.svg"><img src="https://github.com/spacelab-ufsc/eps-re-hardware/blob/master/outputs/eps-re_3D_bottom.svg">
+</p>
 
-## Overview
-
-The Reliability Enhanced EPS has been designed to harvest, store and distribute energy for a future SpaceLab's mission. The energy harvesting system is based on solar energy conversion through 10 solar panels attached to the structure. This EPS is designed to operate the solar panels at their maximum power point. The harvested solar energy is stored in 4 lithium-ion batteries connected in series/parallel. The energy distribution is done by several integrated DC-DC converters. The EPS designed is almost all analog, and therefore more reliable when considering the impact of radiation on the system.
+<p align="center">
+    <a href="https://github.com/spacelab-ufsc/eps-re-hardware/issues/new?labels=bug"><img alt="Static Badge" src="https://img.shields.io/badge/Report_a_bug-red"></a>
+    <a href="https://github.com/spacelab-ufsc/eps-re-hardware/issues/new?labels=enhancement"><img alt="Static Badge" src="https://img.shields.io/badge/Request_a_feature-yellow"></a>
+    <a href="https://github.com/spacela-ufsc/eps-re-hardware/issues/new?labels=question,help+wanted"><img alt="Static Badge" src="https://img.shields.io/badge/Request_more_information_or_help-green"></a>
+</p>
 
 ## Repository Organization
-	- doc: Technical documentation (including mechanical structure, hardware, user guide, and datasheet).
-	- hardware: Sun simulator's hardware project (sources and outputs).
+`sources`: Main files of the RE²PS's hardware project.
 
-## License
+`outputs`: Output files, such as figures of the RE²PS's PCB, schematics, BOM and more.
 
-This project is open-source under three different licenses: CERN Open Hardware License v2.0 for hardware, and CC BY-SA 4.0 for the documentation.
+## License
+This project is open-source under the following license: CERN Open Hardware License v2.0.
 
 ## Releases
 
-## Notes
+Releases are published after  ensuring that the project itself do not have any major errors and after testing the PCB. Please refer to the **documentation** for more details.
 
-t
+## Notes
+For more info about the SpaceLab, access our [GitHub](https://github.com/spacelab-ufsc/spacelab), [Linkedin](https://br.linkedin.com/company/spacelab-ufsc) or our [website](https://spacelab.ufsc.br/en/home/).
 
+## References
+<a id="1">[1]</a> D. L. Figueiredo, "Reliability Enhanced Electrical Power System for Nanosatellites," in <i>Repositório Institucional da UFSC</i>, pp. 1-85, 2023, available at <a href="https://repositorio.ufsc.br/bitstream/handle/123456789/247559/PEEL2103-D.pdf?sequence=1&isAllowed=y"> this link</a>.
 
+<a id="2">[2]</a> C. A. Rigo, L. O. Seman, M. D. Berejuck and E. A. Bezerra, "Printed Circuit Board Design Methodology for Embedded Systems Targeting Space Applications," in IEEE Latin America Transactions, vol. 18, no. 02, pp. 257-264, 2020, available at <a href="https://ieeexplore.ieee.org/document/9085278"> this link</a>.