CY-Bunker ⚡

CY-Bunker is a engineering school project developed by ABAJOU Sofyane, EL JARJINI Hicham, and JAMHOUR Nassim. (Year 2024-2025)
Original subject: C-WIRE 📄
Project report in French: PDF 📑

📋 Instructions

0. 🔧 Before Installing

• Make sure to use Linux or to have downloaded a Linux terminal.
  

1. 🚀 Running the Project

   • Execute the project with the following command:

     ./c-wire.sh <CSV File> <Station Type> <Consumer Type> [Power Plant ID]

   • If you don't have execute permissions, you can run the script with:

     bash c-wire.sh <CSV File> <Station Type> <Consumer Type> [Power Plant ID]

   • Example command:

     ./c-wire.sh input/c-wire_v00.dat hvb comp 1

   • Output files will be located in tmp folder

2. ⚙️ Options

   • <CSV File>: Path to the CSV file. (an example input file is located in input folder)
   • <Station Type>: Type of station (hva, hvb, lv).
   • <Consumer Type>: Type of consumer (comp, indiv, all). Note: hva and hvb stations only works with comp consumers.
   • [Power Plant ID]: (Optional) ID of the power plant, must be a positive number.

3. ❓ Help Manual

   • To display the help manual, use the -h option:

     ./c-wire.sh -h

4. 🧹 Cleaning Up

   • To delete object files and the executable, use the command:

     make clean -C codeC

📦 Dependencies

Before running the project, make sure you have the following installed:

• GCC for compiling C code
• Make for building the project

To install the necessary dependencies on Debian/Ubuntu-based systems, run:

sudo apt update
sudo apt install build-essential

🌐 Made using

👥 Collaborators

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.