diff --git a/README.md b/README.md index 4a2bc75..5dd7d27 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,17 @@ -# gaitmap-challenges & gaitmap-bench + + [![Documentation Status](https://readthedocs.org/projects/gaitmap-bench/badge/?version=latest)](https://gaitmap-bench.readthedocs.io/en/latest/?badge=latest) +# gaitmap-challenges & gaitmap-bench + Reproducible benchmarks for IMU-based gait analysis. This project is part of the gaitmap ecosystem. -Learn more at TODO. +[Learn more](https://gaitmap.readthedocs.io/en/latest/source/user_guide/gaitmap_ecosystem.html) ## gaitmap-challenges + + You have developed an algorithm for gait analysis using foot-mounted IMUs? Then you can use gaitmap-challenges to quickly validate your algorithm using multiple different benchmark challenges. @@ -28,6 +33,7 @@ Other things you can do with gaitmap-challenges: - [Create your own challenge](https://gaitmap-challenges.readthedocs.io/en/latest/creating_challenges.html) ## gaitmap-bench + ### Viewing the results diff --git a/docs/_static/logo/bench.ico b/docs/_static/logo/bench.ico new file mode 100644 index 0000000..f077052 Binary files /dev/null and b/docs/_static/logo/bench.ico differ diff --git a/docs/_static/logo/bench_logo.png b/docs/_static/logo/bench_logo.png new file mode 100644 index 0000000..463d915 Binary files /dev/null and b/docs/_static/logo/bench_logo.png differ diff --git a/docs/_static/logo/bench_logo.svg b/docs/_static/logo/bench_logo.svg new file mode 100644 index 0000000..7f4c9b6 --- /dev/null +++ b/docs/_static/logo/bench_logo.svg @@ -0,0 +1,218 @@ + +image/svg+xml diff --git a/docs/_static/logo/bench_logo_with_text.png b/docs/_static/logo/bench_logo_with_text.png new file mode 100644 index 0000000..5a6f817 Binary files /dev/null and b/docs/_static/logo/bench_logo_with_text.png differ diff --git a/docs/_static/logo/bench_logo_with_text.svg b/docs/_static/logo/bench_logo_with_text.svg new file mode 100644 index 0000000..943f8dc --- /dev/null +++ b/docs/_static/logo/bench_logo_with_text.svg @@ -0,0 +1,235 @@ + +image/svg+xmlBenchgaitmap diff --git a/docs/_static/logo/challenges.ico b/docs/_static/logo/challenges.ico new file mode 100644 index 0000000..c60248c Binary files /dev/null and b/docs/_static/logo/challenges.ico differ diff --git a/docs/_static/logo/challenges_logo.png b/docs/_static/logo/challenges_logo.png new file mode 100644 index 0000000..0d1eede Binary files /dev/null and b/docs/_static/logo/challenges_logo.png differ diff --git a/docs/_static/logo/challenges_logo.svg b/docs/_static/logo/challenges_logo.svg new file mode 100644 index 0000000..8bdb095 --- /dev/null +++ b/docs/_static/logo/challenges_logo.svg @@ -0,0 +1,205 @@ + +image/svg+xml diff --git a/docs/_static/logo/challenges_logo_with_text.png b/docs/_static/logo/challenges_logo_with_text.png new file mode 100644 index 0000000..5e8097a Binary files /dev/null and b/docs/_static/logo/challenges_logo_with_text.png differ diff --git a/docs/_static/logo/challenges_logo_with_text.svg b/docs/_static/logo/challenges_logo_with_text.svg new file mode 100644 index 0000000..e94b942 --- /dev/null +++ b/docs/_static/logo/challenges_logo_with_text.svg @@ -0,0 +1,223 @@ + +image/svg+xmlChallengesgaitmap diff --git a/docs/_static/logo/combined.ico b/docs/_static/logo/combined.ico new file mode 100644 index 0000000..d00084d Binary files /dev/null and b/docs/_static/logo/combined.ico differ diff --git a/docs/_static/logo/combined_logo.png b/docs/_static/logo/combined_logo.png new file mode 100644 index 0000000..6dde646 Binary files /dev/null and b/docs/_static/logo/combined_logo.png differ diff --git a/docs/_static/logo/combined_logo.svg b/docs/_static/logo/combined_logo.svg new file mode 100644 index 0000000..99f405a --- /dev/null +++ b/docs/_static/logo/combined_logo.svg @@ -0,0 +1,479 @@ + + + + diff --git a/docs/_static/logo/combined_logo_with_text.png b/docs/_static/logo/combined_logo_with_text.png new file mode 100644 index 0000000..74bd421 Binary files /dev/null and b/docs/_static/logo/combined_logo_with_text.png differ diff --git a/docs/_static/logo/combined_logo_with_text.svg b/docs/_static/logo/combined_logo_with_text.svg new file mode 100644 index 0000000..b6ad0eb --- /dev/null +++ b/docs/_static/logo/combined_logo_with_text.svg @@ -0,0 +1,520 @@ + + + +Benchgaitmap Challengesgaitmap diff --git a/docs/conf.py b/docs/conf.py index 2071ad8..511159f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,6 +42,7 @@ HERE = Path(__file__).parent with (HERE.parent / "README.md").open() as f: out = f.read() +out = out.replace("./docs/_static/logo/combined_logo_with_text.png", "./_static/logo/combined_logo_with_text.png") with (HERE / "README.md").open("w+") as f: f.write(out) # @@ -121,6 +122,8 @@ # # Activate the theme. html_theme = "sphinx_book_theme" +html_favicon = "_static/logo/combined.ico" +html_logo = "_static/logo/combined_logo.png" html_theme_options = {"repository_url": URL, "use_repository_button": True, "show_prev_next": False} # Add any paths that contain custom static files (such as style sheets) here, diff --git a/docs/logos/README.md b/docs/logos/README.md new file mode 100644 index 0000000..5bbe7d7 --- /dev/null +++ b/docs/logos/README.md @@ -0,0 +1,12 @@ +# Gaitmap Logos + +This folder contains the gaitmap logo source file (`gaitmap_logo_source.svg`). +All versions of the logo are generated from this file using the script `create_all_logos.sh`. + +To run the script you must have inkscape and imagemagik installed. + +The script relies on correct svg-ids for the important parts of the logo. +The small logo is expected to have the svg-id `logo` and the full logo should have the id `logo-with-text`. + +When you modify the logo make sure to run the script and update all files in the `_static/logo` subfolder. +Commit these files. \ No newline at end of file diff --git a/docs/logos/bench.svg b/docs/logos/bench.svg new file mode 100644 index 0000000..2b13bf2 --- /dev/null +++ b/docs/logos/bench.svg @@ -0,0 +1,235 @@ + +image/svg+xmlBenchgaitmap diff --git a/docs/logos/challenges.svg b/docs/logos/challenges.svg new file mode 100644 index 0000000..c120369 --- /dev/null +++ b/docs/logos/challenges.svg @@ -0,0 +1,223 @@ + +image/svg+xmlChallengesgaitmap diff --git a/docs/logos/combined.svg b/docs/logos/combined.svg new file mode 100644 index 0000000..03382c6 --- /dev/null +++ b/docs/logos/combined.svg @@ -0,0 +1,808 @@ + + + +Benchgaitmap Challengesgaitmap diff --git a/docs/logos/create_all_logos.sh b/docs/logos/create_all_logos.sh new file mode 100755 index 0000000..7ea33de --- /dev/null +++ b/docs/logos/create_all_logos.sh @@ -0,0 +1,17 @@ +#!/bin/bash + +target_dir="../_static/logo/" + +# For-loop over values in the sources array +sources=("challenges" "bench" "combined") +for source in "${sources[@]}" +do + inkscape --export-type="png,svg" --export-id="logo-with-text" --export-id-only --export-dpi=250 "${source}.svg" --export-filename="${source}_logo-with-text" + inkscape --export-type="png,svg" --export-id="logo" --export-id-only "${source}.svg" --export-filename="${source}_logo" + mkdir -p "${target_dir}" + mv "${source}_logo.png" "${target_dir}${source}_logo.png" + mv "${source}_logo.svg" "${target_dir}${source}_logo.svg" + mv "${source}_logo-with-text.png" "${target_dir}${source}_logo_with_text.png" + mv "${source}_logo-with-text.svg" "${target_dir}${source}_logo_with_text.svg" + convert "${target_dir}${source}_logo.png" -define icon:auto-resize=64,48,32,16 "${target_dir}${source}.ico" +done