Skip to content

Commit

Permalink
First thing, there's some documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bbenchoff committed Jul 9, 2024
1 parent 72f7f4b commit 519363e
Show file tree
Hide file tree
Showing 36,939 changed files with 3,865,795 additions and 1 deletion.
The diff you're trying to view is too large. We only load the first 3000 changed files.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
# ScriptSynthGUI
A Flask/React GUI for ScriptSynth
A Web-based GUI for writing ScriptSynth configuration files.

## Why? Why would you do this?
ScriptSynth was designed as an easy-to-use tool for data acquisition from various hardware devices. Requiring only a YAML file, ScriptSynth vastly improves on existing solutions by allowing anyone to record data from many hardware devices and save that data to many different platforms and file types.

This was too hard. Because people can't write YAML. Even if there's directions __and examples__ on how to do so in the ScriptSynth README.

So I made this. I made this for people who can't read.

## Features
ScriptSynthGUI is a single-page app, with options on the left, and a preview of the YAML file on the right. Click the 'Save YAML' button to download the YAML file and use it with ScriptSynth.

![Screenshot](/docu/Demo1.PNG)
22 changes: 22 additions & 0 deletions backend/app.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
from flask import Flask, request, send_file, jsonify
from flask_cors import CORS
import yaml
import os

app = Flask(__name__)
CORS(app)

@app.route('/generate-config', methods=['POST'])
def generate_config():
data = request.json
with open('config.yaml', 'w') as file:
yaml.dump(data, file, default_flow_style=False)
return jsonify({'message': 'Config generated successfully!'})

@app.route('/download-config', methods=['GET'])
def download_config():
path = 'config.yaml'
return send_file(path, as_attachment=True)

if __name__ == '__main__':
app.run(debug=True)
26 changes: 26 additions & 0 deletions backend/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
commands:
- baud: ''
command: ''
port: ''
time: ''
hardware:
- acquisition_type: FINITE
buffer_size: '20000'
cage_position: ''
channels:
Channel 0: Sp,etjomg
Channel 1: sp,etjomg else
Channel 2: something
Channel 3: ''
Channel 4: ''
device: ''
hw_type: ''
interface: ''
name: NIDAQ
sampling_freq: '5000'
terminal_config: RSE
metadata: ea;lkjalkjfsadf
output:
CSV: {}
sampling_frequency: 1Hz
test_name: HTOE Test
3 changes: 3 additions & 0 deletions backend/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Flask
flask-cors
PyYAML
Binary file added docu/Demo1.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions frontend/node_modules/.bin/acorn

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 17 additions & 0 deletions frontend/node_modules/.bin/acorn.cmd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

28 changes: 28 additions & 0 deletions frontend/node_modules/.bin/acorn.ps1

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 16 additions & 0 deletions frontend/node_modules/.bin/ansi-html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 17 additions & 0 deletions frontend/node_modules/.bin/ansi-html.cmd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

28 changes: 28 additions & 0 deletions frontend/node_modules/.bin/ansi-html.ps1

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 16 additions & 0 deletions frontend/node_modules/.bin/autoprefixer

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 17 additions & 0 deletions frontend/node_modules/.bin/autoprefixer.cmd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

28 changes: 28 additions & 0 deletions frontend/node_modules/.bin/autoprefixer.ps1

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 16 additions & 0 deletions frontend/node_modules/.bin/browserslist

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 17 additions & 0 deletions frontend/node_modules/.bin/browserslist.cmd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

28 changes: 28 additions & 0 deletions frontend/node_modules/.bin/browserslist.ps1

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 16 additions & 0 deletions frontend/node_modules/.bin/css-blank-pseudo

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 17 additions & 0 deletions frontend/node_modules/.bin/css-blank-pseudo.cmd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

28 changes: 28 additions & 0 deletions frontend/node_modules/.bin/css-blank-pseudo.ps1

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 519363e

Please sign in to comment.