-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
63dac90
commit 10d0bab
Showing
1 changed file
with
72 additions
and
287 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,313 +1,98 @@ | ||
| # 🚀 AstroWind | ||
| # Scope Dataset Website (Full Version available soon) | ||
|
|
||
| <img src="https://raw.githubusercontent.com/onwidget/.github/main/resources/astrowind/lighthouse-score.png" align="right" | ||
| alt="AstroWind Lighthouse Score" width="100" height="358"> | ||
|  | ||
|
|
||
| 🌟 _Most *starred* & *forked* Astro theme in 2022 & 2023_. 🌟 | ||
| Here you can download the official Toolkit for the [SCOPE dataset](https://ekut-es.github.io/scope/). | ||
| The Toolkit provides functionality for an efficient parallel download, visualization and evaluation of Collective Perception Algorithms. | ||
|
|
||
| **AstroWind** is a free and open-source template to make your website using **[Astro 4.0](https://astro.build/) + [Tailwind CSS](https://tailwindcss.com/)**. Ready to start a new project and designed taking into account web best practices. | ||
|  | ||
|
|
||
| - ✅ **Production-ready** scores in **PageSpeed Insights** reports. | ||
| - ✅ Integration with **Tailwind CSS** supporting **Dark mode** and **_RTL_**. | ||
| - ✅ **Fast and SEO friendly blog** with automatic **RSS feed**, **MDX** support, **Categories & Tags**, **Social Share**, ... | ||
| - ✅ **Image Optimization** (using new **Astro Assets** and **Unpic** for Universal image CDN). | ||
| - ✅ Generation of **project sitemap** based on your routes. | ||
| - ✅ **Open Graph tags** for social media sharing. | ||
| - ✅ **Analytics** built-in Google Analytics, and Splitbee integration. | ||
| ## Installation | ||
|
|
||
| <br> | ||
| Use the package manager [pip](https://pip.pypa.io/en/stable/) to install the Toolkit. | ||
|
|
||
| <img src="https://raw.githubusercontent.com/onwidget/.github/main/resources/astrowind/screenshot-astrowind-1.png" alt="AstroWind Theme Screenshot"> | ||
|
|
||
| [](https://onwidget.com) | ||
| [](https://github.com/onwidget/astrowind/blob/main/LICENSE.md) | ||
| [](https://github.com/onwidget) | ||
| [](https://github.com/onwidget/astrowind#contributing) | ||
| [](https://snyk.io/test/github/onwidget/astrowind) | ||
| [](https://github.com/onwidget/astrowind) | ||
| [](https://github.com/onwidget/astrowind) | ||
|
|
||
| <br> | ||
|
|
||
| <details open> | ||
| <summary>Table of Contents</summary> | ||
|
|
||
| - [Demo](#demo) | ||
| - [Upcoming: AstroWind 2.0 – We Need Your Vision!](#-upcoming-astrowind-20--we-need-your-vision) | ||
| - [Getting started](#getting-started) | ||
| - [Project structure](#project-structure) | ||
| - [Commands](#commands) | ||
| - [Configuration](#configuration) | ||
| - [Deploy](#deploy) | ||
| - [Frequently Asked Questions](#frequently-asked-questions) | ||
| - [Related Projects](#related-projects) | ||
| - [Contributing](#contributing) | ||
| - [Acknowledgements](#acknowledgements) | ||
| - [License](#license) | ||
|
|
||
| </details> | ||
|
|
||
| <br> | ||
|
|
||
| ## Demo | ||
|
|
||
| 📌 [https://astrowind.vercel.app/](https://astrowind.vercel.app/) | ||
|
|
||
| <br> | ||
|
|
||
| ## 🔔 Upcoming: AstroWind 2.0 – We Need Your Vision! | ||
|
|
||
| We're embarking on an exciting journey with **AstroWind 2.0**, and we want you to be a part of it! We're currently taking the first steps in developing this new version and your insights are invaluable. Join the discussion and share your feedback, ideas, and suggestions to help shape the future of **AstroWind**. Let's make **AstroWind 2.0** even better, together! | ||
|
|
||
| [Share Your Feedback in Our Discussion!](https://github.com/onwidget/astrowind/discussions/392) | ||
|
|
||
| <br> | ||
|
|
||
| ## Getting started | ||
|
|
||
| **AstroWind** tries to give you quick access to creating a website using [Astro 4.0](https://astro.build/) + [Tailwind CSS](https://tailwindcss.com/). It's a free theme which focuses on simplicity, good practices and high performance. | ||
|
|
||
| Very little vanilla javascript is used only to provide basic functionality so that each developer decides which framework (React, Vue, Svelte, Solid JS...) to use and how to approach their goals. | ||
| ```bash | ||
| pip install scope-toolkit | ||
| ``` | ||
|
|
||
| In this version the template supports all the options in the `output` configuration, `static`, `hybrid` and `server`, but the blog only works with `prerender = true`. We are working on the next version and aim to make it fully compatible with SSR. | ||
| ## Usage | ||
| Once installed, you can start using the Toolkit to enhance your workflow with the SCOPE dataset. | ||
|
|
||
| ### Project structure | ||
| ### Download | ||
|
|
||
| Inside **AstroWind** template, you'll see the following folders and files: | ||
| The Toolkit allows efficient parallel downloading and extraction into the correct structure of the SCOPE dataset. | ||
|
|
||
| Simply run | ||
| ``` | ||
| / | ||
| ├── public/ | ||
| │ ├── _headers | ||
| │ └── robots.txt | ||
| ├── src/ | ||
| │ ├── assets/ | ||
| │ │ ├── favicons/ | ||
| │ │ ├── images/ | ||
| │ │ └── styles/ | ||
| │ │ └── tailwind.css | ||
| │ ├── components/ | ||
| │ │ ├── blog/ | ||
| │ │ ├── common/ | ||
| │ │ ├── ui/ | ||
| │ │ ├── widgets/ | ||
| │ │ │ ├── Header.astro | ||
| │ │ │ └── ... | ||
| │ │ ├── CustomStyles.astro | ||
| │ │ ├── Favicons.astro | ||
| │ │ └── Logo.astro | ||
| │ ├── content/ | ||
| │ │ ├── post/ | ||
| │ │ │ ├── post-slug-1.md | ||
| │ │ │ ├── post-slug-2.mdx | ||
| │ │ │ └── ... | ||
| │ │ └-- config.ts | ||
| │ ├── layouts/ | ||
| │ │ ├── Layout.astro | ||
| │ │ ├── MarkdownLayout.astro | ||
| │ │ └── PageLayout.astro | ||
| │ ├── pages/ | ||
| │ │ ├── [...blog]/ | ||
| │ │ │ ├── [category]/ | ||
| │ │ │ ├── [tag]/ | ||
| │ │ │ ├── [...page].astro | ||
| │ │ │ └── index.astro | ||
| │ │ ├── index.astro | ||
| │ │ ├── 404.astro | ||
| │ │ ├-- rss.xml.ts | ||
| │ │ └── ... | ||
| │ ├── utils/ | ||
| │ ├── config.yaml | ||
| │ └── navigation.js | ||
| ├── package.json | ||
| ├── astro.config.mjs | ||
| └── ... | ||
| cd ~/dataset-toolkit | ||
| python dataset-toolkit/TODO_ADD_PATH_TO/download_dataset.py | ||
| ``` | ||
| and follow the on-screen instructions. | ||
|
|
||
| Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. | ||
|
|
||
| There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. | ||
|
|
||
| Any static assets, like images, can be placed in the `public/` directory if they do not require any transformation or in the `assets/` directory if they are imported directly. | ||
|
|
||
| [](https://githubbox.com/onwidget/astrowind/tree/main) [](https://gitpod.io/?on=gitpod#https://github.com/onwidget/astrowind) [](https://stackblitz.com/github/onwidget/astrowind) | ||
|
|
||
| > 🧑🚀 **Seasoned astronaut?** Delete this file `README.md`. Update `src/config.yaml` and contents. Have fun! | ||
| <br> | ||
|
|
||
| ### Commands | ||
|
|
||
| All commands are run from the root of the project, from a terminal: | ||
|
|
||
| | Command | Action | | ||
| | :-------------------- | :------------------------------------------------- | | ||
| | `npm install` | Installs dependencies | | ||
| | `npm run dev` | Starts local dev server at `localhost:3000` | | ||
| | `npm run build` | Build your production site to `./dist/` | | ||
| | `npm run preview` | Preview your build locally, before deploying | | ||
| | `npm run format` | Format codes with Prettier | | ||
| | `npm run lint:eslint` | Run Eslint | | ||
| | `npm run astro ...` | Run CLI commands like `astro add`, `astro preview` | | ||
|
|
||
| <br> | ||
|
|
||
| ### Configuration | ||
|
|
||
| Basic configuration file: `./src/config.yaml` | ||
|
|
||
| ```yaml | ||
| site: | ||
| name: 'Example' | ||
| site: 'https://example.com' | ||
| base: '/' # Change this if you need to deploy to Github Pages, for example | ||
| trailingSlash: false # Generate permalinks with or without "/" at the end | ||
| ### Visualization | ||
|
|
||
| googleSiteVerificationId: false # Or some value, | ||
|  | ||
|  | ||
|
|
||
| # Default SEO metadata | ||
| metadata: | ||
| title: | ||
| default: 'Example' | ||
| template: '%s — Example' | ||
| description: 'This is the default meta description of Example website' | ||
| robots: | ||
| index: true | ||
| follow: true | ||
| openGraph: | ||
| site_name: 'Example' | ||
| images: | ||
| - url: '~/assets/images/default.png' | ||
| width: 1200 | ||
| height: 628 | ||
| type: website | ||
| twitter: | ||
| handle: '@twitter_user' | ||
| site: '@twitter_user' | ||
| cardType: summary_large_image | ||
| The visualization module allows for an easy exploration of the dataset. | ||
|
|
||
| i18n: | ||
| language: en | ||
| textDirection: ltr | ||
|
|
||
| apps: | ||
| blog: | ||
| isEnabled: true # If the blog will be enabled | ||
| postsPerPage: 6 # Number of posts per page | ||
|
|
||
| post: | ||
| isEnabled: true | ||
| permalink: '/blog/%slug%' # Variables: %slug%, %year%, %month%, %day%, %hour%, %minute%, %second%, %category% | ||
| robots: | ||
| index: true | ||
|
|
||
| list: | ||
| isEnabled: true | ||
| pathname: 'blog' # Blog main path, you can change this to "articles" (/articles) | ||
| robots: | ||
| index: true | ||
|
|
||
| category: | ||
| isEnabled: true | ||
| pathname: 'category' # Category main path /category/some-category, you can change this to "group" (/group/some-category) | ||
| robots: | ||
| index: true | ||
|
|
||
| tag: | ||
| isEnabled: true | ||
| pathname: 'tag' # Tag main path /tag/some-tag, you can change this to "topics" (/topics/some-category) | ||
| robots: | ||
| index: false | ||
|
|
||
| isRelatedPostsEnabled: true # If a widget with related posts is to be displayed below each post | ||
| relatedPostsCount: 4 # Number of related posts to display | ||
|
|
||
| analytics: | ||
| vendors: | ||
| googleAnalytics: | ||
| id: null # or "G-XXXXXXXXXX" | ||
|
|
||
| ui: | ||
| theme: 'system' # Values: "system" | "light" | "dark" | "light:only" | "dark:only" | ||
|
|
||
| tokens: | ||
| default: | ||
| fonts: | ||
| sans: InterVariable | ||
| serif: InterVariable | ||
| heading: InterVariable | ||
| colors: | ||
| default: rgb(16 16 16) | ||
| heading: rgb(0 0 0) | ||
| muted: rgb(16 16 16 / 66%) | ||
| bgPage: rgb(255 255 255) | ||
| primary: rgb(1 97 239) | ||
| secondary: rgb(1 84 207) | ||
| accent: rgb(109 40 217) | ||
| dark: | ||
| fonts: {} | ||
| colors: | ||
| default: rgb(229 236 246) | ||
| heading: rgb(247, 248, 248) | ||
| muted: rgb(229 236 246 / 66%) | ||
| bgPage: rgb(3 6 32) | ||
| primary: rgb(1 97 239) | ||
| secondary: rgb(1 84 207) | ||
| accent: rgb(109 40 217) | ||
| To visualize a scenario run | ||
| ``` | ||
| <br> | ||
| ### Deploy | ||
| #### Deploy to production (manual) | ||
| You can create an optimized production build with: | ||
| ```shell | ||
| npm run build | ||
| cd ~/dataset-toolkit | ||
| python dataset-toolkit/TODO_ADD_PATH_TO/visualize_sequence.py | ||
| ``` | ||
| and follow the on-screen instructions. | ||
| This will create a GIF of the selected scenario while following the selected car in the given scenario. | ||
|
|
||
| Currently there are a few different perspectives implemented. Those are | ||
|
|
||
| ```mermaid | ||
| graph TD | ||
| A{Viewpoint} -->|third-person/roof Camera+LiDAR| B(roof-option) | ||
| A --> |bird's eye view 45° only LiDAR| C[GIF] | ||
| B -->|front view| D(camera alignment) | ||
| B -->|front to back| E(camera alignment) | ||
| D --> |next to| F[GIF] | ||
| D --> |above| G[GIF] | ||
| E --> |next to| H[GIF] | ||
| E --> |above| I[GIF] | ||
| ``` | ||
|
|
||
| Now, your website is ready to be deployed. All generated files are located at | ||
| `dist` folder, which you can deploy the folder to any hosting service you | ||
| prefer. | ||
|
|
||
| #### Deploy to Netlify | ||
|
|
||
| Clone this repository on own GitHub account and deploy to Netlify: | ||
|
|
||
| [](https://app.netlify.com/start/deploy?repository=https://github.com/onwidget/astrowind) | ||
|
|
||
| #### Deploy to Vercel | ||
|
|
||
| Clone this repository on own GitHub account and deploy to Vercel: | ||
|
|
||
| [](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fonwidget%2Fastrowind) | ||
|
|
||
| <br> | ||
|
|
||
| ## Frequently Asked Questions | ||
|
|
||
| - Why? | ||
| - | ||
| - | ||
|
|
||
| <br> | ||
|
|
||
| ## Related projects | ||
|
|
||
| - [TailNext](https://tailnext.vercel.app/) - Free template using Next.js 14 and Tailwind CSS with the new App Router. | ||
| - [Qwind](https://qwind.pages.dev/) - Free template to make your website using Qwik + Tailwind CSS. | ||
| ### Evaluation (TODO) | ||
| Evaluation module for easy and fair comparison of different methods using state-of-the-art metrics | ||
| TODO | ||
|
|
||
| ## Contributing | ||
| ## Data Structure | ||
| Our data structure optimises data management and analysis with unique features: | ||
|
|
||
| If you have any idea, suggestions or find any bugs, feel free to open a discussion, an issue or create a pull request. | ||
| That would be very useful for all of us and we would be happy to listen and take action. | ||
| It separates environmental conditions, ensuring independent assessment of weather conditions. The hierarchical arrangement includes sensor data and transformation matrices per vehicle per scenario, enabling systematic management. Coordinate transformation is simplified with pre-existing matrices for each vehicle and sensor. In addition, support for common file formats such as .bin, .txt and .png ensures efficient data loading. | ||
|
|
||
| ## Acknowledgements | ||
|  | ||
|
|
||
| Initially created by [onWidget](https://onwidget.com) and maintained by a community of [contributors](https://github.com/onwidget/astrowind/graphs/contributors). | ||
| ### Ground Truth Format (.csv) | ||
| This section outlines the structure and contents of the ground truth data stored in a CSV (Comma-Separated Values) format. The table provides an overview of the fields present in the CSV file. | ||
|  | ||
|
|
||
| ## License | ||
| Each column is a separate field, such as the following | ||
| ```CSV | ||
| m_type << "," << m_id << "," << m_realworld_pos.x() << "," << m_realworld_pos.y() << "," << m_realworld_pos.z() << "," << m_realworld_dim.width <<... | ||
| ``` | ||
|
|
||
| **AstroWind** is licensed under the MIT license — see the [LICENSE](./LICENSE.md) file for details. | ||
| The different types are | ||
|
|
||
| | Type ID | Description | | ||
| |---------|---------------| | ||
| | 0 | BACKGROUND | | ||
| | 1 | CAR | | ||
| | 2 | VAN | | ||
| | 3 | TRUCK | | ||
| | 4 | PEDESTRIAN | | ||
| | 5 | PERSON_SITTING| | ||
| | 6 | CYCLIST | | ||
| | 7 | TRAM | | ||
| | 8 | MISC | | ||
| | 9 | MOTORBIKE | | ||
|
|
||
| ## Citation | ||
| If you use our SCOPE dataset or the toolkit, please use the following citation |