README.md

VLE Diagram

A project support for designing distillation collumn
Explore the docs »

App view · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License

About The Project

VLE Diagram is a tool I used when solving distillation problem. Here the reason for this project:

• I was through a tough time dealing with this kind of chart using hand drawing and interpolate from it. The error could be enormous and affect later calculation 😕

• So I decide to implement while I had a course project about designing a distillation collumn. You can visually interact with the chart

• Data can be edited easily on the go 😲

(back to top)

Built With

Project was built on main tech stack

Flask

Tailwind CSS

(back to top)

Getting Started

Here is how you can set up to project on you local machine

Prerequisites

You machine must have python3 to continue. You can download and install at their official page

Installation

Below is the instruction how to run project on you local machine

1. Clone the repo

   git clone https://github.com/tuanlearntocode/VLE

2. Install requirement file

   pip install -r requirements.txt

3. (Optional) Turn on Flask debugger in app.py

    if __name__ == "__main__":
        app.run(debug=True) # default is False

4. Run command

   py app.py

5. Go to http://127.0.0.1:5000 to see the result

(back to top)

Usage

Here is step by step to use :

1. Create a google sheet and set shared link with role "Editor"

2. Sheet name same as composition name

3. Add url to web and hit Upload

4. Fill $x_f, x_d, x_w$ field and hit Submit

5. The chart will show on the side and result at below

Here is example google sheet: mysheet. You can follow this template.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)