Skip to content

Commit f0967a6

Browse files
committed
Better explanation of software versions in homepage
1 parent dbec0a6 commit f0967a6

File tree

1 file changed

+70
-63
lines changed

1 file changed

+70
-63
lines changed

docs/index.md

Lines changed: 70 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ title: Home
1717

1818
Get up and running in minutes
1919

20-
[:octicons-arrow-right-24: Getting started](software/legacy_qt/setup/project.md)
20+
[:fontawesome-brands-linux: Install the legacy version](software/legacy_qt/index.md)
2121

22-
[:fontawesome-brands-docker: Check a dockerized version](https://hub.docker.com/r/aaronrpb/force-platform-app)
22+
[:fontawesome-brands-docker: Install the docker version](software/docker_streamlit/index.md) [(DockerHub repo)](https://hub.docker.com/r/aaronrpb/force-platform-app)
2323

2424
- :fontawesome-solid-microchip:{ .lg .middle } __Sensor compatibility__
2525

@@ -75,6 +75,8 @@ A python software for synchronized data management of specific force platforms s
7575
This project is part of the [author](https://github.com/AaronPB)'s master's thesis in industrial engineering at the University of Almería
7676
and funded by the "[Programa Operativo FEDER 2014-2020](https://www.miteco.gob.es/es/ministerio/servicios/ayudas-subvenciones/fondos_feder.html)" and the Andalusian "Consejería de Transformación Económica, Industria, Conocimiento y Universidades", under the project UAL2020-CTS-A2100.
7777

78+
[:fontawesome-solid-book:   More information about the project](platform/index.md){ .md-button .md-button--primary }
79+
7880
<figure markdown="span">
7981
![union_europea-junta_de_andalucia](assets/union_europea-junta_de_andalucia.png#only-light){ width="500px" }
8082
![union_europea-junta_de_andalucia](assets/union_europea-junta_de_andalucia_modooscuro.png#only-dark){ width="500px" }
@@ -84,18 +86,6 @@ and funded by the "[Programa Operativo FEDER 2014-2020](https://www.miteco.gob.e
8486

8587
</div>
8688

87-
<div class="grid cards" markdown>
88-
89-
- :fontawesome-solid-file-pdf:{ .lg .middle } __SOFTWARE DEVELOPMENT AND CALIBRATION OF A FORCE PLATFORM FOR SPORTS SCIENCE__
90-
91-
---
92-
93-
Check the master's thesis in spanish by clicking the button below.
94-
95-
[:fontawesome-solid-globe: &nbsp; Institutional repository *(available soon)*](#){ .md-button .md-button--secondary }
96-
97-
</div>
98-
9989
### A flexible configuration
10090

10191
<div class="grid" markdown>
@@ -197,76 +187,37 @@ For more details, check out the following documentation page:
197187

198188
<div markdown>
199189

200-
You can visualize the recorded data directly from the graphs tabs.
190+
You can visualize the recorded data directly from the graph tabs.
201191

202192
There are graphs for each recorded sensor, as well as specific ones depending on the sensor group type, such as force platforms.
203193

204194
It is also possible to trim the data and adjust the Butterworth filter used for signal processing.
205195

206196
For data export, the CSV format is used, allowing both raw data export and processed data export using the sensors' calibration parameters.
207-
</div>
208197

209198
</div>
210199

211-
### Quick setup
212-
213-
<div class="grid cards" markdown>
214-
215-
- :fontawesome-brands-docker:{ .lg .middle } __Simpler? A dockerized and optimized version is available!__
216-
217-
---
218-
219-
Just a quick `docker pull` in your docker environment and you are ready to go!
220-
221-
=== "From DockerHub"
222-
223-
``` bash
224-
docker pull aaronrpb/force-platform-app && \
225-
docker run -d --name example_app \
226-
--device /dev/bus/usb \
227-
--device /dev/ttyUSB0 \
228-
--device /dev/ttyUSB1 \
229-
-p 8501:8501 \
230-
aaronrpb/force-platform-app
231-
```
200+
</div>
232201

233-
=== "From GHCR"
202+
## Software versions
234203

235-
``` bash
236-
docker pull ghcr.io/aaronpb/force-platform-app && \
237-
docker run -d --name example_app \
238-
--device /dev/bus/usb \
239-
--device /dev/ttyUSB0 \
240-
--device /dev/ttyUSB1 \
241-
-p 8501:8501 \
242-
ghcr.io/aaronpb/force-platform-app
243-
```
204+
<div class="grid" markdown>
244205

245-
[:fontawesome-brands-docker: DockerHub](https://hub.docker.com/r/aaronrpb/force-platform-app){ .md-button .md-button--primary }
246-
[:fontawesome-brands-github: GitHub repository](https://github.com/AaronPB/force-platform-app){ .md-button .md-button--primary }
247-
[:fontawesome-solid-download: Detailed docker setup steps](software/docker_streamlit/setup/project_linux.md){ .md-button .md-button--secondary }
206+
<div markdown>
248207

249-
</div>
208+
### Legacy version
250209

210+
[:fontawesome-brands-github: GitHub repository](https://github.com/AaronPB/force_platform){ .md-button .md-button--primary }
251211

252-
<div class="grid" markdown>
212+
This version was originally developed for internal use, with Python and QT.
253213

254-
<div markdown>
255214
Install the required dependencies and clone the project into your workspace.
256-
257215
You can follow this steps to set it up in a few minutes.
258216

259217
!!! warning "Only Linux distributions are supported, preferably Ubuntu 22.04 LTS"
260218
The project has been developed and tested in Ubuntu 22.04 LTS. Phidget does support [Windows](https://www.phidgets.com/docs/OS_-_Windows#Quick_Downloads)
261219
and [MacOS](https://www.phidgets.com/docs/OS_-_macOS#Quick_Downloads), but Taobotics IMUs do not.
262220

263-
!!! tip
264-
Do it in a virtual environment to avoid module installation issues (using `virtualenv`, for example).
265-
266-
This project is developed with Python v3.10.6
267-
</div>
268-
269-
<div markdown>
270221
<div class="grid cards" markdown>
271222

272223
- :fontawesome-solid-terminal:{ .lg .middle } __Step 1: Install the external dependencies__
@@ -283,8 +234,8 @@ You can follow this steps to set it up in a few minutes.
283234
=== "MRPT"
284235

285236
``` bash
286-
sudo add-apt-repository ppa:joseluisblancoc/mrpt
287-
sudo apt install libmrpt-dev mrpt-apps
237+
sudo add-apt-repository ppa:joseluisblancoc/mrpt &&\
238+
sudo apt install libmrpt-dev mrpt-apps &&\
288239
sudo apt install python3-pymrpt
289240
```
290241

@@ -312,6 +263,62 @@ You can follow this steps to set it up in a few minutes.
312263
pip install -r requirements.txt
313264
```
314265

266+
!!! tip
267+
Do it in a virtual environment to avoid module installation issues (using `virtualenv`, for example).
268+
269+
This project is developed with Python v3.10.6
270+
271+
</div>
272+
</div>
273+
274+
<div markdown>
275+
276+
### Docker version
277+
278+
[:fontawesome-brands-github: GitHub repository](https://github.com/AaronPB/force-platform-app){ .md-button .md-button--primary }
279+
[:fontawesome-brands-docker: DockerHub](https://hub.docker.com/r/aaronrpb/force-platform-app){ .md-button .md-button--primary }
280+
281+
An optimized and comfortable option, with the main features.
282+
283+
Simple to install using Docker, and with all the documentation available inside the app, ready to go!
284+
285+
!!! success "Available for Windows and Linux distros"
286+
The project has been tested in Windows 11, Ubuntu 22.04 LTS and Fedora Workstation 41. It has not been tested in MacOS, but it has a high chance to also work, as it is a dockerized version.
287+
288+
<div class="grid cards" markdown>
289+
290+
- :fontawesome-brands-docker:{ .lg .middle } __Step 1: Run a new docker container__
291+
292+
---
293+
294+
Just a quick `docker run` in your docker environment and you are ready to go!
295+
296+
=== "From DockerHub"
297+
298+
``` bash
299+
docker run -d --name example_app \
300+
--device /dev/bus/usb \
301+
--device /dev/ttyUSB0 \
302+
--device /dev/ttyUSB1 \
303+
-p 8501:8501 \
304+
aaronrpb/force-platform-app
305+
```
306+
307+
=== "From GHCR"
308+
309+
``` bash
310+
docker run -d --name example_app \
311+
--device /dev/bus/usb \
312+
--device /dev/ttyUSB0 \
313+
--device /dev/ttyUSB1 \
314+
-p 8501:8501 \
315+
ghcr.io/aaronpb/force-platform-app
316+
```
317+
318+
!!! note "Add or remove arguments depending on your setup. For more information click below."
319+
320+
[:fontawesome-solid-download: Detailed docker setup steps](software/docker_streamlit/setup/project_linux.md){ .md-button .md-button--secondary }
321+
315322
</div>
316323
</div>
317324

0 commit comments

Comments
 (0)