https://github.com/jsonfm/remio-mockup-template
💡🧪🔬 A remote experiment example template made with REMIO. ⚙️
https://github.com/jsonfm/remio-mockup-template
css html js pyqt5 python socket-io
Last synced: about 2 months ago
JSON representation
💡🧪🔬 A remote experiment example template made with REMIO. ⚙️
- Host: GitHub
- URL: https://github.com/jsonfm/remio-mockup-template
- Owner: jsonfm
- License: apache-2.0
- Created: 2022-06-26T23:02:47.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-23T03:58:07.000Z (over 3 years ago)
- Last Synced: 2025-10-21T03:46:30.527Z (8 months ago)
- Topics: css, html, js, pyqt5, python, socket-io
- Language: Python
- Homepage:
- Size: 295 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### 🌏🧪 Remio Mockup Template
This is a python template for making experiment with `remio` library. It gives to you a project structure, a some utils for developing quickly remote laboratory projects.
### 🎨 GUI
The project includes a simple GUI made with `PyQt5`. It looks as follows:
You could edit it according to your needs. I recommed to you use `QtDesigner` program which simplifies the GUI creation proccess.
### 💬 Communications Schema
The project uses a simple mechanism to establish bidirectional communications in real time, using the `socketio` protocol/library.
### 🗂️ Structure
Some folders were created to help you structure the project:
```
.
├── arduino
│ └── mockup
│ └── mockup.ino
├── docs
├── public
├── server
├── utils
├── gui.py
├── gui.ui
├── production.py
├── README.md
├── requirements.txt
└── settings.py
```
### ⚙️ Installation
Clone the repository:
```
git clone https://github.com/jsonfm/remio-mockup-template.git [your-project-name]
```
Create and activate a virtual environment:
```bash
python3 -m venv venv
source venv/bin/activate
```
### ⚒️ Dependencies
After you set the virutal env, install dependencies:
```
pip install -r requirements.txt
```
### ⚡️ Development
This experiment uses PyQt5 framework to provide a GUI.
```
python gui.py
```
### 🚀 Production
To run the experiment without the local GUI (production), you could use the `product.py` file:
```
python production.py
```
### ✨ SocketIO Server
A socketio server was added for do some tests.
```
python run_server.py
```