Commit b0f8336d authored by pooja.mulaguri's avatar pooja.mulaguri

updated release notes and readme file

parent 5bad1819
# siam-custom
# OEE Services
OEE Monitoring
Custom OEE project for Siam
![js-standard-style](https://img.shields.io/badge/OEE%20Monitoring%20-Beta-yellow?style=for-the-badge&logo=python&logoColor=blue)
[![FastAPI 0.73.0](https://img.shields.io/badge/FastAPI-005571?style=for-the-badge&logo=fastapi)](https://fastapi.tiangolo.com/)
[![Python 3.9](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/release/python-390/)
[![pydantic 1.9](https://img.shields.io/badge/Pydantic-1.9-pink.svg)](https://pypi.org/project/pydantic/)
<img src="https://unifytwin.com/assets/imgs/UT_logo.png" width="300" align="right"></img>
# UnifyTwin OEE v6.5
By [Unify Twin](https://unifytwin.com)
OEE is used for monitoring and tracking performance of the machine.
### Technologies
Developed using following libraries:
- Python 3.9
## Getting Started
The instructions below will get you a copy of the project up and running on your local machine for development and testing purposes.
*See deployment section for notes on how to deploy the project on a live system.*
### Prerequisites
**Note:** This project requires **python >=v3.9**.
### Setting Up Development Environment
Follow the instructions below to setup development environment.
**Install Python Package dependencies**
```bash
pip install -r requirements.txt
```
### Environment variables
Add environment variables in .env file to run application.
**Start the Application**
```bash
python app.py --port <port_number>
# or
uvicorn main:app --host 0.0.0.0 --port <port> --proxy-headers
```
**Start OEE Agent**
```bash
python live_dashboard.py --project_id <project_id>
```
Not specifying the port will make the app start in the port specified in the config file.
## Authors
* **Irfanuddin**
* **Harshavardhan**
* **Irfan Rayachuru**
* **Sudheer**
## Maintainers
* **Irfanuddin**
* **Harshavardhan**
Release Note:
1.OEE monitoring with tags
2.Live OEE for equipment level
Feature:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment