Preparing final repo

main
jaume-nualart 2 months ago
parent 3b4d9462fd
commit 4ff0a0deb4
  1. 116
      README.md

@ -1,12 +1,13 @@
= TimberVis Flexiboard =
- [Instructions](#instructions)
- [Introduction](#introduction)
- [What does the application do?](#what-does-the-application-do)
- [GIT Repository](#git-repository)
- [Installation](#installation)
- [Prerequisites](#prerequisites)
- [Instructions](#instructions-1)
- [Prepare your dataset: database input format](#prepare-your-dataset-database-input-format)
- [Instructions](#instructions)
- [Files and folders:](#files-and-folders)
- [API documentation:](#api-documentation)
- [Parallel](#parallel)
@ -18,7 +19,7 @@
# Instructions
# Introduction
This is a web application developed by Infravis.se for the Structural Health Monitoring research group at the Department at Building Technology, all from the Linneuniversitetet, Växjö, Sweden. This project has been developed from March to December 2023-
@ -58,6 +59,15 @@ The code of this application is accessible and can be downloaded from the Git re
Werkzeug 2.3.7
- The app uses sqlite to store the data. Sqlite is included in Python3.
## Prepare your dataset: database input format
- Each house in its own subfolder of 'Data'. The name of the subfolder will be used as the ID of the house.
- Inside the subfolder, the .TXT files with the sensor data should be name as "CARD-YEAR-MONTH.TXT"
- For example: 1-2022-10.TXT for October 2022, card 1.
- It does not matter if the TXT files are organized into subfolders. The import script will find them.
## Instructions
1. Prepare your dataset in a file like my_database.db
@ -71,56 +81,56 @@ The code of this application is accessible and can be downloaded from the Git re
## Files and folders:
/Data/ -> datasets for each project. Create a folder name for each project. This folder name must be defined in web-html/config/datamap.js [Check Installation ( Instructions for the files(folders structure for each project]\
Data/Charlie\
Data/Pilgatan
/py/\
Data/Boards -> Saved boards are here. For a fresh installation, this folder can be empty\
    output_import.txt\
    Charlie.db\
    main.py\
    Pilgatan.db\
    README.md
/web-html/\
web-html/config  -> Configuration files that need to be edited\
    config.js -> General variables\
    datamap.js -> Specific variables for each project included in the flexiboard
web-html/css -> CSS styles used\
    bootstrap-datepicker3.css\
    c3.css\
    quill.snow.css\
    bootstrap-icons.css\
    dash.css\
    winbox.min.css\
    bootstrap.min.css\
    font-awesome.min.css
web-html/js -> JS flexiboard functions\
    dash.js\
    home.js
web-html/lib .> JS libraries used\
    bootstrap.bundle.min.js\
    d3-horizon-chart0.0.5.js\
    moment.min.js\
    bootstrap-datepicker.min.js\
    d3.v4.js\
    quill.js\
    bootstrap-datetimepicker.min.js\
    jquery-3.7.0.min.js\
    c3.js\
    jquery-ui.js
web-html/imgs  -> Put here the images defined in web-html/config/datamap.js\
    infravis.jpg\
    infravis.ico\
    ...
dash.html -> Main page\
index.html -> Home page
* /Data/ -> datasets for each project. Create a folder name for each project. This folder name must be defined in web-html/config/datamap.js [Check Installation ( Instructions for the files(folders structure for each project]\
* Data/Charlie\
* Data/Pilgatan
* /py/\
* Data/Boards -> Saved boards are here. For a fresh installation, this folder can be empty\
* output_import.txt\
* Charlie.db\
* main.py\
* Pilgatan.db\
* README.md
* /web-html/\
* web-html/config  -> Configuration files that need to be edited\
* config.js -> General variables\
* datamap.js -> Specific variables for each project included in the flexiboard
* web-html/css -> CSS styles used\
* bootstrap-datepicker3.css\
* c3.css\
* quill.snow.css\
* bootstrap-icons.css\
* dash.css\
* winbox.min.css\
* bootstrap.min.css\
* font-awesome.min.css
* web-html/js -> JS flexiboard functions\
* dash.js\
* home.js
* web-html/lib .> JS libraries used\
* bootstrap.bundle.min.js\
* d3-horizon-chart0.0.5.js\
* moment.min.js\
* bootstrap-datepicker.min.js\
* d3.v4.js\
* quill.js\
* bootstrap-datetimepicker.min.js\
* jquery-3.7.0.min.js\
* c3.js\
* jquery-ui.js
* web-html/imgs  -> Put here the images defined in web-html/config/datamap.js\
* infravis.jpg\
* infravis.ico\
* ...
* dash.html -> Main page\
* index.html -> Home page

Loading…
Cancel
Save