EGSim

Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

EGSim is a vapor compression system tool developed based on physics-based simulation for typical mini-split air conditioning systems comprised of a compressor, discharge line, condenser, liquid line, capillary tube, 2-phase line, evaporator, and suction line. The tool was funded under support from UNIDO through the Egyptian HPMP-II.

(back to top)

Getting Started

Prerequisites

• For the compiled EXE file, all Python modules needed are already incorporated inside the compiled file

• For the Python interface, you will need to install python first. The software has been tested on python 3.8.7, but you may use the latest python version. You will also need to install the following modules for Python:

  • appdirs
  • CoolProp
  • lxml
  • matplotlib
  • numpy
  • openpyxl
  • pandas
  • PsychroLib
  • pyperclip
  • PyQt5
  • scikit_learn
  • scipy
  • sympy

  To install all the packages at once, you can use the following command

  python -m pip install appdirs CoolProp lxml matplotlib numpy openpyxl pandas PsychroLib pyperclip PyQt5 scikit_learn scipy sympy

Installation

• To use the Compiled exe file, install the latest release through Here. You might encounter an error during installation because of the admin privileges; if so, try installing the tool in somewhere else other than in program files folder.

• To use the python code instead of the compiled exe file:

  1. Create the folder %USERNAME%\appdata\Local\EGSim
  2. Copy EGSim folder in the repository to inside the created folder from step 1, so that the path would be %USERNAME%\appdata\Local\EGSim\EGSim
  3. Run the software using EGSim.py file

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the CC BY-NC-ND License. See LICENSE.md for more information.

(back to top)

Contact

Omar Zaki - [email protected]

Omar Abdelaziz, PhD - [email protected] - [email protected]

Project Link: https://github.com/OmarZaki96/EGSim

(back to top)

Acknowledgments

We would like to thank UNIDO for their continuous support of the project through Egyptian HPMP-II.

Thanks to Dr. Ian Bell for his work on ACHP which inspired some the ideas used in EGSim.

(back to top)