Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[NO_BUILD] Added first draft of python wheel documentation #4325

Merged
merged 21 commits into from
Jul 30, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
b44451c
Added first draft of python wheel documentation
corkyw10 Jun 21, 2021
6b063e6
Removed the 2 from pip2
corkyw10 Jun 21, 2021
7aa5133
Merge branch 'dev' into corkyw10/python-wheel-documentation
corkyw10 Jun 21, 2021
1b3b6ae
Updated wheel flag info and linux requirements
corkyw10 Jul 13, 2021
8bc4038
Merge branch 'dev' into corkyw10/python-wheel-documentation
corkyw10 Jul 13, 2021
1f84bec
Merge branch 'dev' into corkyw10/python-wheel-documentation
corkyw10 Jul 19, 2021
9305e83
Updated build docs with information about whl's and egg's
corkyw10 Jul 26, 2021
7f773b5
Updated installation and build docs to reflect the new ways to instal…
corkyw10 Jul 27, 2021
244f0a3
Removed summary sections from build docs. The process is too complica…
corkyw10 Jul 27, 2021
aa4d665
Merge branch 'dev' into corkyw10/python-wheel-documentation
corkyw10 Jul 27, 2021
b7df3b6
Corrections on python wheel docs
corkyw10 Jul 27, 2021
afbc1ae
Merge branch 'corkyw10/python-wheel-documentation' of https://github.…
corkyw10 Jul 27, 2021
32e134b
Merge branch 'dev' into corkyw10/python-wheel-documentation
corkyw10 Jul 27, 2021
9213db9
Removed python version references
corkyw10 Jul 27, 2021
5ad74a4
Merge branch 'corkyw10/python-wheel-documentation' of https://github.…
corkyw10 Jul 27, 2021
3bf9ea1
Removing/fixing irrelevant parts of the docs and fixing example code …
corkyw10 Jul 28, 2021
05ab126
Merge branch 'dev' into corkyw10/python-wheel-documentation
corkyw10 Jul 29, 2021
0fd4004
Corrected python versions on windows and quickstart and removed repai…
corkyw10 Jul 29, 2021
6d7be43
Merge branch 'dev' into corkyw10/python-wheel-documentation
corkyw10 Jul 29, 2021
ce45e16
Merge branch 'dev' into corkyw10/python-wheel-documentation
corkyw10 Jul 29, 2021
4fe9d16
Merge branch 'dev' into corkyw10/python-wheel-documentation
corkyw10 Jul 30, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Removing/fixing irrelevant parts of the docs and fixing example code …
…snippets.
  • Loading branch information
corkyw10 committed Jul 28, 2021
commit 3bf9ea1e3c73a7d08c78b1c08f0d529ec1589eb7
4 changes: 2 additions & 2 deletions Docs/build_faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ CARLA forum</a>
> If running a script returns an output similar to this, there is a problem with the `.egg` file in the PythonAPI.

!!! Important
CARLA used `.egg` files for the client library in versions prior to 0.9.12. If you are using 0.9.12+, `.whl` files are used instead and the information in this section will not be relevant to you.
If you are using 0.9.12+, there are several methods to use/install the client library. If you are using one of the newer methods for the client library (`.whl` or PyPi download) the information in this section will not be relevant to you.
>
> First of all, open `<root_carla>/PythonAPI/carla/dist`. There should be an `.egg` file for the corresponding CARLA and Python version you are using (similar to `carla-0.X.X-pyX.X-linux-x86_64.egg`). Make sure the file matches the Python version you are using. To check your Python version use the following command.
>
Expand Down Expand Up @@ -415,4 +415,4 @@ pip3 uninstall carla
pip uninstall carla
```

---
---
7 changes: 0 additions & 7 deletions Docs/build_windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,13 +203,6 @@ The following command compiles the Python API client:
make PythonAPI
```

Optionally, to compile the PythonAPI for a specific version of Python, run the below command in the root CARLA directory.

```sh
# Delete versions as required
make PythonAPI ARGS="--python-version=2.7, 3.6, 3.7, 3.8"
```

The CARLA client library will be built in two distinct, mutually exclusive forms. This gives users the freedom to choose which form they prefer to run the CARLA client code. The two forms include `.egg` files and `.whl` files. Choose __one__ of the following options below to use the client library:

__A. `.egg` file__
Expand Down
40 changes: 20 additions & 20 deletions Docs/tuto_G_retrieve_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -840,18 +840,18 @@ Hereunder are the two scripts gathering the fragments of code for this tutorial.
<summary><b>tutorial_ego.py</b> </summary>

```py
# import glob
# import os
# import sys
import glob
import os
import sys
import time

# try:
# sys.path.append(glob.glob('../carla/dist/carla-*%d.%d-%s.egg' % (
# sys.version_info.major,
# sys.version_info.minor,
# 'win-amd64' if os.name == 'nt' else 'linux-x86_64'))[0])
# except IndexError:
# pass
try:
sys.path.append(glob.glob('../carla/dist/carla-*%d.%d-%s.egg' % (
sys.version_info.major,
sys.version_info.minor,
'win-amd64' if os.name == 'nt' else 'linux-x86_64'))[0])
except IndexError:
pass

import carla

Expand Down Expand Up @@ -1075,20 +1075,20 @@ if __name__ == '__main__':
<summary><b>tutorial_replay.py</b></summary>

```py
# import glob
# import os
# import sys
import glob
import os
import sys
import time
import math
import weakref

# try:
# sys.path.append(glob.glob('../carla/dist/carla-*%d.%d-%s.egg' % (
# sys.version_info.major,
# sys.version_info.minor,
# 'win-amd64' if os.name == 'nt' else 'linux-x86_64'))[0])
# except IndexError:
# pass
try:
sys.path.append(glob.glob('../carla/dist/carla-*%d.%d-%s.egg' % (
sys.version_info.major,
sys.version_info.minor,
'win-amd64' if os.name == 'nt' else 'linux-x86_64'))[0])
except IndexError:
pass

import carla

Expand Down