Skip to content

Commit

Permalink
better build error docs and removing svn remarks #2
Browse files Browse the repository at this point in the history
  • Loading branch information
behrisch committed Apr 15, 2024
1 parent 63eb0db commit c25abe8
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 16 deletions.
39 changes: 23 additions & 16 deletions docs/web/docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -371,10 +371,10 @@ client version and SUMO version match. When using SUMO version 1.0.0 or larger y

### How do I access the code repository?

Since 2018-04-10 SUMO moved to [the organizational Eclipse account at GitHub](https://github.com/eclipse-sumo/sumo/). You have the choice to
access the repository using git or subversion. There are plenty of
clients for all platforms. If you use the command line client, you
can checkout sumo using the following command (for git):
SUMO uses git for version control and [is available on GitHub](https://github.com/eclipse-sumo/sumo/).
Subversion is not supported anymore.
There are plenty of git clients for all platforms. If you use the command line client, you
can checkout sumo using the following command:

```
git clone --recursive https://github.com/eclipse-sumo/sumo
Expand All @@ -384,16 +384,15 @@ If you want to see the full project history in your git checkout please
change to the created directory and call

```
git fetch origin refs/replace/*:refs/replace/*
git fetch origin refs/replace/*:refs/replace/*
```

For later updates go inside the sumo directory, which has been created,
and simply type `git pull`.

### Is there further documentation on Git and Subversion?
### Is there further documentation on Git?

There are the [Git book](https://git-scm.com/book/) and the
[Subversion book](https://svnbook.red-bean.com/) and the [GitHub help](https://help.github.com/) is also worth reading.
There is the [Git book](https://git-scm.com/book/) and the [GitHub help](https://help.github.com/) is also worth reading.

### How to get an older version of SUMO?

Expand All @@ -403,9 +402,8 @@ and simply type `git pull`.

### How to check out revision 5499 (or any other outdated sumo)?

You can use the subversion option "**-r <REVISION_NUMBER\>**"
together with the checkout on the command line. If you are using git
you can find the correct hash using the git log. You have to consult
You can use the following command to find the correct git hash for a subversion revision:
`git log | grep trunk@5499 -B 10` in your (git) bash. You have to consult
your client's documentation if you use a graphical interface. Please
be aware of the fact that we can only give very limited support for
older versions.
Expand All @@ -415,6 +413,14 @@ and simply type `git pull`.
We compile regularly under Windows 10 using Visual Studio 2019 and have daily builds on
Linux. SUMO can also be installed on macOS via Homebrew (or built from source).

#### Which python version and package manager should I use?

Any [Python version which still receives updates](https://devguide.python.org/versions/)
should be fine. If you have the choice, use the one before the latest.
Please try to install a vanilla python and use only pip or the package manager of your
system (e.g. apt). Do not use Anaconda or any derivatives thereof! It tends to break
the library search path so the binaries like sumo will not work anymore (and self compiling will not fix it).

### Can I run multiple versions of SUMO alongside each other?

Different versions of SUMO generally do not interfere with each
Expand All @@ -426,7 +432,8 @@ and simply type `git pull`.
### Letters and words are represented as squares in sumo-gui and netedit

Make sure that your computer supports 3D Acceleration and graphical
drivers are correctly installed and configured.
drivers are correctly installed and configured. It will probably not
work on mahcines accessed via RDP or a similar remote desktop protocol.

### Troubleshooting

Expand Down Expand Up @@ -1013,14 +1020,14 @@ Calculated as ` 24 * 3600 * 80000 / 1800 = 3840000 `

By default, the same configuration will result in the same behavior even though many parts of the simulation are [randomized](Simulation/Randomness.md).
This reproducibility is often necessary (i.e. for debugging a scenario).
However, to avoid biases from this "fixed" randomness it is often useful to run the simulation multiple times and perform analysis on the ensemble of results.
However, to avoid biases from this "fixed" randomness it is often useful to run the simulation multiple times and perform analysis on the ensemble of results.
Likewise, in the real world different days have different traffic and it is more reliable to draw conclusions from multiple days rather than a single day.

To change the default randomness, either option **--seed** or option **--random** must be used. The first option sets a user-defined intialization for the random number generator whereas the other picks a random seed (which will be different on every run).

!!! note
These options apply to sumo, duarouter and many python tools which employ randomization.

In order to collect distinct output from multiple runs, it is advisable to set option **--output-prefix**.
Running a simulation 3 times with different results could be done in a batch file like this:

Expand All @@ -1045,7 +1052,7 @@ i.e. if simulations where run with the option `<statistic-output value="stats.xm
The [osmWebWizard](Tutorials/OSMWebWizard.md) tool provides the simplest solution to obtain a scenario with background images.
Selecting the checkbox 'Satellite background' before generating the scenario is sufficient. To select another image provider, the tool [tileGet.py](Tools/Misc.md#tilegetpy) can also be used.

It is important to know that the network projection will be changed from UTM to [Mercator](https://en.wikipedia.org/wiki/Web_Mercator_projection) if the checkbox "satellite background" is enabled. This is necessary to match the projection of popular satellite image providers. However, this projection has the unwelcome propertie of distorting lengths much more strongly than the default project. Depending on the area being imported, distances could be doubled (or worse).
It is important to know that the network projection will be changed from UTM to [Mercator](https://en.wikipedia.org/wiki/Web_Mercator_projection) if the checkbox "satellite background" is enabled. This is necessary to match the projection of popular satellite image providers. However, this projection has the unwelcome propertie of distorting lengths much more strongly than the default project. Depending on the area being imported, distances could be doubled (or worse).

The revert such a projection to UTM, the following commands may be used:

Expand Down Expand Up @@ -1201,7 +1208,7 @@ Under windows these settings must be configured using `regedit` i.e. at the regi
### The tool fails when adding an argument with a leading minus sign

Many of our tools use an argument parser to gather further command line arguments.
As the option names usually start with a leading minus, the parser gets confused whether your input is
As the option names usually start with a leading minus, the parser gets confused whether your input is
an option or the corresponding value. In this case try the `--option=value` syntax.

### tools fail with an ImportError
Expand Down
4 changes: 4 additions & 0 deletions docs/web/docs/Installing/Linux_Build.md
Original file line number Diff line number Diff line change
Expand Up @@ -388,6 +388,10 @@ For details see
[stackoverflow](https://stackoverflow.com/questions/335928/ld-cannot-find-an-existing-library)
discussion.

### ld cannot find certain functions in an existing external library

Make sure you don't have an environment like anaconda installed which modifies your library search path.

### Additional notes for Cygwin users

At the moment GUI building is still troublesome. It depends whether you
Expand Down

0 comments on commit c25abe8

Please sign in to comment.