Skip to content

Commit

Permalink
Merge pull request #3385 from CyrineKamoun/main
Browse files Browse the repository at this point in the history
feat: docs_troubleshooting
  • Loading branch information
nihar1024 authored Nov 20, 2024
2 parents d1763d1 + 5ed3590 commit cb9b679
Show file tree
Hide file tree
Showing 9 changed files with 162 additions and 6 deletions.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,5 @@ All contributors to GOAT are expected to follow our Code of Conduct. This docume

## Feedback and Support

If you have any questions, comments, or feedback about GOAT please feel free to [contact us](mailto:info@plan4better.de). We appreciate your contributions and look forward to working with you!
If you have any questions, comments, or feedback about GOAT please feel free to [contact us](mailto:info@plan4better.de). We appreciate your contributions and look forward to working with you!

4 changes: 2 additions & 2 deletions apps/docs/docs/routing/public_transport.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ The following default configurations are used while performing public transport
- **Decay function type:** logistic
- **Standard deviation:** 12 minutes
- **Width:** 10 minutes
- **Walk speed:** 1.39 km/h
- **Walk speed:** 5 km/h
- **Maximum walk time:** 20 minutes
- **Bike speed:** 4.166666666666667 km/h
- **Bike speed:** 15 km/h
- **Maximum bike time:** 20 minutes
- **Bike traffic stress:** 4
- **Maximum rides:** 4
Expand Down
76 changes: 76 additions & 0 deletions apps/docs/docs/troubleshooting/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
sidebar_position: 10
slug: /troubleshooting
---

# Troubleshooting

This page is here to guide you through issues or constraints while using GOAT, making it easier to solve them and continue progressing with your analysis.
:::tip INFO
Feel free to [contact us](https://plan4better.de/en/contact/ "contact us") for support or any further questions you may have.
:::

## Job failure
You can find below common job failure and suggestions to solve them.

* Jobs cannot exceed two minutes length. There is also a limit on the number of features that can be analyzed for each indicator.
<div style={{ display: "flex", alignItems: "center" }}>
<img
src={require('/img/troubleshooting/arrow-right.png').default}
alt="Layers"
style={{ maxHeight: "20px", maxWidth: "20px", objectFit: "cover", marginRight: "8px" }}
/>
<span>
<strong>To perform analysis on large area, you can use the <a href="map/filter">Filter</a> to split your analysis into smaller areas.</strong>
</span>
</div>

![Filtering to compute larger areas](/img/troubleshooting/filtering.jpg "Filtering to compute larger areas")

For example, if you use the public transport trip count indicator in an area and a time period where no trip is performed; the job fails with the error: **The Layer is None**
<div style={{ display: "flex", alignItems: "center" }}>
<img
src={require('/img/troubleshooting/arrow-right.png').default}
alt="Layers"
style={{ maxHeight: "20px", maxWidth: "20px", objectFit: "cover", marginRight: "8px" }}
/>
<span>
<strong>You can try expanding the spatial or temporal range of your analysis.</strong>
</span>
</div>

## Accessibility Indicators

### Heatmap Gravity
The sensitivity of a Gaussian impedance function cannot be higher than 1,000,000.
<div style={{ display: "flex", alignItems: "center" }}>
<img
src={require('/img/troubleshooting/arrow-right.png').default}
alt="Layers"
style={{ maxHeight: "20px", maxWidth: "20px", objectFit: "cover", marginRight: "8px" }}
/>
<span>
<strong>You can use the suggested sensitivities in GOAT as a reference.</strong>
</span>
</div>

### Catchment area
The starting points of the indicator must be within 100m of the road network.
<div style={{ display: "flex", alignItems: "center" }}>
<img
src={require('/img/troubleshooting/arrow-right.png').default}
alt="Layers"
style={{ maxHeight: "20px", maxWidth: "20px", objectFit: "cover", marginRight: "8px" }}
/>
<span>
<strong> To accurately set your starting points on the map, you can visualize the network either directly with the basemap or by using the street network layer in the scenario. </strong>
</span>
</div>

![Routing start point](/img/troubleshooting/routing_start.jpeg "Routing start point")


## Uploading datasets

If you try to upload a dataset type that is not supported by GOAT, an error occurs. See supported [dataset types](data/dataset_types)

Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ Die folgenden Standardkonfigurationen werden beim Routing für den öffentlichen
- **Abklingfunktionstyp:** logistisch
- **Standardabweichung:** 12 Minuten
- **Breite:** 10 Minuten
- **Gehgeschwindigkeit:** 1,39 km/h
- **Gehgeschwindigkeit:** 5 km/h
- **Maximale Gehzeit:** 20 Minuten
- **Fahrradgeschwindigkeit:** 4,166666666666667 km/h
- **Fahrradgeschwindigkeit:** 15 km/h
- **Maximale Fahrradzeit:** 20 Minuten
- **Radverkehrsbelastung:** 4
- **Maximale Fahrten:** 4
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
sidebar_position: 10
slug: /troubleshooting
---

# Fehlerbehebung

Diese Seite hilft Ihnen bei Problemen oder Einschränkungen bei der Verwendung von GOAT, um diese einfacher zu lösen und mit Ihrer Analyse fortzufahren.

:::tip INFO
Zögern Sie nicht, uns für Unterstützung oder weitere Fragen [hier](https://plan4better.de/de/contact/ "hier") zu kontaktieren.
:::

## Job-Fehler

Wenn Sie eine Analyse in einem Projekt ausführen, wird die Aufgabe in der Software als **Job** bezeichnet. Eine Fehlermeldung mit **Job-Fehler** bedeutet, dass die Aufgabe nicht ausgeführt werden konnte. Um mehr über die Ursache des Fehlers zu erfahren, überprüfen Sie bitte die [Statusleiste](workspace/home#statusleiste). Nachfolgend finden Sie häufige Ursachen für Job-Fehler und Vorschläge zu deren Behebung.

* Jobs dürfen eine Dauer von zwei Minuten nicht überschreiten. Es gibt außerdem eine Begrenzung für die Anzahl der Features, die für jeden Indikator analysiert werden können.
<div style={{ display: "flex", alignItems: "center" }}>
<img
src={require('/img/troubleshooting/arrow-right.png').default}
alt="Layers"
style={{ maxHeight: "20px", maxWidth: "20px", objectFit: "cover", marginRight: "8px" }}
/>
<span>
<strong>Sie können den <a href="map/filter">Filter</a> verwenden, um Ihre Analyse in kleinere Ebenen zu unterteilen.</strong>
</span>
</div>

![Filtern zur Berechnung größerer Flächen](/img/troubleshooting/filtering.jpg "Filtern zur Berechnung größerer Flächen")


* Wenn Sie einen Indikator berechnen, das Ergebnis jedoch leer ist, wird kein Output generiert und ein Job-Fehler tritt auf. Beispiel: Wenn Sie den Indikator Abfahrten ÖPNV in einem Gebiet und einem Zeitraum verwenden, in dem keine Fahrten stattfinden, schlägt der Job mit dem Fehler fehl: **The Layer is None**.
<div style={{ display: "flex", alignItems: "center" }}>
<img
src={require('/img/troubleshooting/arrow-right.png').default}
alt="Layers"
style={{ maxHeight: "20px", maxWidth: "20px", objectFit: "cover", marginRight: "8px" }}
/>
<span>
<strong>Versuchen Sie, den räumlichen oder zeitlichen Bereich Ihrer Analyse zu erweitern.</strong>
</span>
</div>


## Erreichbarkeitsindikatoren
### Heatmap - Durchschnitt Reisezeit
* Die Sensitivität einer Gaußschen Impedanzfunktion darf 1.000.000 nicht überschreiten.
<div style={{ display: "flex", alignItems: "center" }}>
<img
src={require('/img/troubleshooting/arrow-right.png').default}
alt="Layers"
style={{ maxHeight: "20px", maxWidth: "20px", objectFit: "cover", marginRight: "8px" }}
/>
<span>
<strong>Sie können die vorgeschlagenen Empfindlichkeiten in GOAT als Referenz verwenden.</strong>
</span>
</div>

### Einzugsgebiet
* Die Startpunkte des Indikators müssen sich innerhalb von 100 m vom Straßennetz befinden.
<div style={{ display: "flex", alignItems: "center" }}>
<img
src={require('/img/troubleshooting/arrow-right.png').default}
alt="Layers"
style={{ maxHeight: "20px", maxWidth: "20px", objectFit: "cover", marginRight: "8px" }}
/>
<span>
<strong>Um Ihre Startpunkte auf der Karte genau festzulegen, können Sie das Netzwerk entweder direkt mit der Basiskarte oder mit der Straßennetzschicht im Szenario visualisieren.</strong>
</span>
</div>


![Startpunkt der Streckenführung](/img/troubleshooting/routing_start.jpeg "Startpunkt der Streckenführung")



## Hochladen von Datensätzen

* Wenn Sie versuchen, einen Datensatz hochzuladen, der von GOAT nicht unterstützt wird, tritt ein Fehler auf. Siehe die autorisierten [Datensatztypen](data/dataset_types).
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@
"engines": {
"node": ">=16.0.0"
},
"packageManager": "pnpm@9.5.0",
"dependencies": {
"@types/memoizee": "^0.4.8"
}
Expand Down

0 comments on commit cb9b679

Please sign in to comment.