diff options
Diffstat (limited to 'python-beamngpy.spec')
| -rw-r--r-- | python-beamngpy.spec | 755 |
1 files changed, 755 insertions, 0 deletions
diff --git a/python-beamngpy.spec b/python-beamngpy.spec new file mode 100644 index 0000000..8edb732 --- /dev/null +++ b/python-beamngpy.spec @@ -0,0 +1,755 @@ +%global _empty_manifest_terminate_build 0 +Name: python-beamngpy +Version: 1.26 +Release: 1 +Summary: Python API to interact with BeamNG.tech. +License: MIT +URL: https://github.com/BeamNG/BeamNGpy +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/e8/ab/7664f06dd4183a7bf300a7f6fcb84e2eb65a91bc4ca3fb55ce5355590ad2/beamngpy-1.26.tar.gz +BuildArch: noarch + +Requires: python3-numpy +Requires: python3-msgpack +Requires: python3-Pillow +Requires: python3-Jinja2 +Requires: python3-PyOpenGL +Requires: python3-scipy +Requires: python3-matplotlib +Requires: python3-seaborn + +%description +# BeamNGpy
+<a href="https://beamngpy.readthedocs.io/en/latest/"><img src="https://github.com/BeamNG/BeamNGpy/raw/master/media/documentation.png" /></a>
+
+**BeamNGpy** is an official library providing a Python API to [BeamNG.tech][11],
+the academia- and industry-oriented fork of the video game [BeamNG.drive][4].
+BeamNGpy and BeamNG.tech are designed to go hand in hand, both being kept up
+to date to support each other's functions, meaning using the latest versions
+of both is recommended.
+
+It allows remote control of the simulation, including vehicles contained in it.
+See [Features](#features) or go through the [Feature Overview][10] Jupyter notebook.
+
+## Table of Contents
+
+ - [Features](#features)
+ - [Prerequisites](#prereqs)
+ - [Installation](#installation)
+ - [Usage](#usage)
+ - [Compatibility](#compatibility)
+ - [Troubleshooting](#troubleshooting)
+
+<a name="features"></a>
+
+## Features
+
+BeamNGpy comes with a wide range of low-level functions to interact with the
+simulation and a few higher-level interfaces that make more complex actions
+easier. Some features to highlight are:
+
+### Remote Control of Vehicles
+
+Each vehicle can be controlled individually and independently during the
+simulation. This includes basic steering inputs, but also controls over
+various lights (headlights, indicators, etc.) or gear shifting.
+
+[Throttle Control.webm](https://user-images.githubusercontent.com/93574498/207164528-2415691f-3aee-478e-91ae-a1a53f733ee6.webm)
+
+[Steering Control.webm](https://user-images.githubusercontent.com/93574498/207164554-3f3d9478-3970-4c08-b1e3-2b656313ae33.webm)
+
+### AI-controlled Vehicles
+
+Besides manual control, BeamNG.tech ships with its own AI to control vehicles.
+This AI can be configured and controlled from BeamNGpy. It can be used to
+make a vehicle drive to a certain waypoint, make it follow another vehicle,
+span the map, or follow a user-defined trajectory:
+
+
+
+### Dynamic Sensor Models
+
+Vehicles and the environment can be equipped with various sensors that provide
+simulated sensor data. These sensors include:
+
+ - Cameras
+ - Color camera
+ - Depth camera
+ - Semantic and Instance annotations
+ - Lidars
+ - Inertial Measurement Units
+ - Ultrasonic Distance Measurements
+
+
+
+
+These sensors give perfect data from the simulation by default. Therefore, some
+of them, like the camera and lidar sensor, can be equipped to also simulate
+noisy data.
+
+### Access to Road Network & Scenario Objects
+
+Geometry of roads in the currently-loaded level/scenario are made available
+via BeamNGpy. Objects and vehicles that are currently active in the scene
+are also exposed, allowing for analysis of the current simulation state.
+
+
+
+### Multiple Clients
+
+BeamNGpy interacts with BeamNG.tech as the client, with BeamNG.tech acting
+as the server. This allows for multiple BeamNGpy processes to connect to a
+running simulation and have each control the simulator, making it possible
+to, for example, [run a scenario in which each vehicle is controlled by
+a separate client.](https://github.com/BeamNG/BeamNGpy/tree/master/examples/multi_client.ipynb)
+
+### More
+
+There is a healthy collection of usage examples in the [examples/](https://github.com/BeamNG/BeamNGpy/tree/master/examples)
+folder of this repository. These highlight more features, but also serve
+as documentation, so be sure to check them out.
+
+<a name="prereqs"></a>
+
+## Prerequisites
+
+Usage of BeamNGpy requires BeamNG.tech to be installed. Builds of
+BeamNG.tech are made available for non-commercial use upon request using
+[this form][2]. For commercial use, contact us at [licensing@beamng.gmbh][3].
+Once downloaded, you can use the environment variable `BNG_HOME` to where
+BeamNG.tech can be run from, or provide a path to the BeamNGpy library
+during initialization.
+
+The regular [Steam release of BeamNG.drive][4] is compatible to an extent as
+well. Certain sensors like the simulated LiDAR or camera will not work, but
+most of the functions that are not exclusive to a Tech build will likely
+work.
+
+<a name="installation"></a>
+
+## Installation
+
+The library itself is available on [PyPI][5] and can therefore be installed
+using common methods like `pip`:
+
+ pip install beamngpy
+
+If you use [Anaconda](https://www.anaconda.com/products/distribution#download-section), you can
+install BeamNGpy from the `conda-forge` channel by:
+
+ conda install beamngpy -c conda-forge
+
+To upgrade, use
+
+ pip install --upgrade beamngpy
+
+if you installed BeamNGpy using `pip` or
+
+ conda update beamngpy -c conda-forge --no-pin
+
+if you installed it using `conda`.
+
+<a name="usage"></a>
+
+## Usage
+
+**DISCLAIMER:** If you are using an older version of `beamngpy` and BeamNG.tech, please follow the
+instructions of the corresponding `README` file (for example, [1.22 instructions](https://github.com/BeamNG/BeamNGpy/tree/v1.22)).
+
+The library can be imported using `import beamngpy`. A short
+usage example setting up a scenario with one vehicle in the West Coast USA map
+that spans the area is:
+
+```python
+from beamngpy import BeamNGpy, Scenario, Vehicle
+
+# Instantiate BeamNGpy instance running the simulator from the given path,
+# communicating over localhost:64256
+bng = BeamNGpy('localhost', 64256, home='/path/to/bng/tech', user='/path/to/bng/tech/userfolder')
+# Launch BeamNG.tech
+bng.open()
+# Create a scenario in west_coast_usa called 'example'
+scenario = Scenario('west_coast_usa', 'example')
+# Create an ETK800 with the licence plate 'PYTHON'
+vehicle = Vehicle('ego_vehicle', model='etk800', license='PYTHON')
+# Add it to our scenario at this position and rotation
+scenario.add_vehicle(vehicle, pos=(-717, 101, 118), rot_quat=(0, 0, 0.3826834, 0.9238795))
+# Place files defining our scenario for the simulator to read
+scenario.make(bng)
+
+# Load and start our scenario
+bng.scenario.load(scenario)
+bng.scenario.start()
+# Make the vehicle's AI span the map
+vehicle.ai.set_mode('span')
+input('Hit enter when done...')
+```
+
+We have a [guide][6] helping you getting started and navigating our collection of examples and
+the documentation of the library is available [here][7].
+
+## Compatibility
+
+BeamNG.tech is not a finished product but is still under development.
+Thus frequent changes on the simulation side are to be expected.
+While the BeamNGpy library maintains compatibility between minor versions for the user, this doesn't extend to the BeamNG.tech side. Not all BeamNGpy versions are compatible with all BeamNG.tech versions.
+Below is a list of compatible BeamNG.tech and BeamNGpy versions.
+However we do not maintain minor versions: bug fixes and new features will only be available for the newest BeamNG.tech and BeamNGpy releases.
+
+| BeamNG.tech version | BeamNGpy version |
+| ------------------- | --------------------------------------------------------- |
+| 0.28 | [1.26](https://github.com/BeamNG/BeamNGpy/tree/v1.26) |
+| 0.27 | [1.25.1](https://github.com/BeamNG/BeamNGpy/tree/v1.25.1) |
+| 0.26 | [1.24](https://github.com/BeamNG/BeamNGpy/tree/v1.24) |
+| 0.25 | [1.23.1](https://github.com/BeamNG/BeamNGpy/tree/v1.23.1) |
+| 0.24 | [1.22](https://github.com/BeamNG/BeamNGpy/tree/v1.22) |
+| 0.23 | [1.21.1](https://github.com/BeamNG/BeamNGpy/tree/v1.21.1) |
+| 0.22 | [1.20](https://github.com/BeamNG/BeamNGpy/tree/v1.20) |
+| 0.21 | [1.19.1](https://github.com/BeamNG/BeamNGpy/tree/v1.19.1) |
+
+## Troubleshooting
+
+This section lists common issues with BeamNGpy in particular. Since this
+library is closely tied to BeamNG.tech and thus BeamNG.drive, it is also
+recommended to consult the documentation on BeamNG.drive here:
+
+[https://documentation.beamng.com/][8]
+
+### BeamNGpy cannot establish a connection
+
+ - Be sure to complete the initial set up step described in the Usage section and to repeat it with every newly released BeamNG.tech version.
+ - Make sure BeamNG.tech and Python are allowed to connect to your current
+ network in Windows Firewall.
+
+### BeamNG.tech quietly fails to launch
+
+- There is a known issue where BeamNG.tech quietly crashes when there is a
+ space in the configured userpath. Until this issue is fixed, it is
+ recommended to either switch to a path that does not contain a space or
+ change the userpath directly in the "startup.ini" file located in the
+ directory of your BeamNG.tech installation.
+
+## Contributions
+
+We always welcome user contributions, be sure to check out our [contribution guidelines][9] first, before starting your work.
+
+[1]: https://beamngpy.readthedocs.io/en/latest/
+[2]: https://register.beamng.tech/
+[3]: mailto:licensing@beamng.gmbh
+[4]: https://store.steampowered.com/app/284160/BeamNGdrive/
+[5]: https://pypi.org/project/beamngpy/
+[6]: https://github.com/BeamNG/BeamNGpy/blob/master/examples/guide.md
+[7]: https://beamngpy.readthedocs.io/en/latest/
+[8]: https://documentation.beamng.com/
+[9]: https://github.com/BeamNG/BeamNGpy/blob/master/contributing.md
+[10]: https://github.com/BeamNG/BeamNGpy/blob/master/examples/feature_overview.ipynb
+[11]: https://beamng.tech/
+ + +%package -n python3-beamngpy +Summary: Python API to interact with BeamNG.tech. +Provides: python-beamngpy +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-beamngpy +# BeamNGpy
+<a href="https://beamngpy.readthedocs.io/en/latest/"><img src="https://github.com/BeamNG/BeamNGpy/raw/master/media/documentation.png" /></a>
+
+**BeamNGpy** is an official library providing a Python API to [BeamNG.tech][11],
+the academia- and industry-oriented fork of the video game [BeamNG.drive][4].
+BeamNGpy and BeamNG.tech are designed to go hand in hand, both being kept up
+to date to support each other's functions, meaning using the latest versions
+of both is recommended.
+
+It allows remote control of the simulation, including vehicles contained in it.
+See [Features](#features) or go through the [Feature Overview][10] Jupyter notebook.
+
+## Table of Contents
+
+ - [Features](#features)
+ - [Prerequisites](#prereqs)
+ - [Installation](#installation)
+ - [Usage](#usage)
+ - [Compatibility](#compatibility)
+ - [Troubleshooting](#troubleshooting)
+
+<a name="features"></a>
+
+## Features
+
+BeamNGpy comes with a wide range of low-level functions to interact with the
+simulation and a few higher-level interfaces that make more complex actions
+easier. Some features to highlight are:
+
+### Remote Control of Vehicles
+
+Each vehicle can be controlled individually and independently during the
+simulation. This includes basic steering inputs, but also controls over
+various lights (headlights, indicators, etc.) or gear shifting.
+
+[Throttle Control.webm](https://user-images.githubusercontent.com/93574498/207164528-2415691f-3aee-478e-91ae-a1a53f733ee6.webm)
+
+[Steering Control.webm](https://user-images.githubusercontent.com/93574498/207164554-3f3d9478-3970-4c08-b1e3-2b656313ae33.webm)
+
+### AI-controlled Vehicles
+
+Besides manual control, BeamNG.tech ships with its own AI to control vehicles.
+This AI can be configured and controlled from BeamNGpy. It can be used to
+make a vehicle drive to a certain waypoint, make it follow another vehicle,
+span the map, or follow a user-defined trajectory:
+
+
+
+### Dynamic Sensor Models
+
+Vehicles and the environment can be equipped with various sensors that provide
+simulated sensor data. These sensors include:
+
+ - Cameras
+ - Color camera
+ - Depth camera
+ - Semantic and Instance annotations
+ - Lidars
+ - Inertial Measurement Units
+ - Ultrasonic Distance Measurements
+
+
+
+
+These sensors give perfect data from the simulation by default. Therefore, some
+of them, like the camera and lidar sensor, can be equipped to also simulate
+noisy data.
+
+### Access to Road Network & Scenario Objects
+
+Geometry of roads in the currently-loaded level/scenario are made available
+via BeamNGpy. Objects and vehicles that are currently active in the scene
+are also exposed, allowing for analysis of the current simulation state.
+
+
+
+### Multiple Clients
+
+BeamNGpy interacts with BeamNG.tech as the client, with BeamNG.tech acting
+as the server. This allows for multiple BeamNGpy processes to connect to a
+running simulation and have each control the simulator, making it possible
+to, for example, [run a scenario in which each vehicle is controlled by
+a separate client.](https://github.com/BeamNG/BeamNGpy/tree/master/examples/multi_client.ipynb)
+
+### More
+
+There is a healthy collection of usage examples in the [examples/](https://github.com/BeamNG/BeamNGpy/tree/master/examples)
+folder of this repository. These highlight more features, but also serve
+as documentation, so be sure to check them out.
+
+<a name="prereqs"></a>
+
+## Prerequisites
+
+Usage of BeamNGpy requires BeamNG.tech to be installed. Builds of
+BeamNG.tech are made available for non-commercial use upon request using
+[this form][2]. For commercial use, contact us at [licensing@beamng.gmbh][3].
+Once downloaded, you can use the environment variable `BNG_HOME` to where
+BeamNG.tech can be run from, or provide a path to the BeamNGpy library
+during initialization.
+
+The regular [Steam release of BeamNG.drive][4] is compatible to an extent as
+well. Certain sensors like the simulated LiDAR or camera will not work, but
+most of the functions that are not exclusive to a Tech build will likely
+work.
+
+<a name="installation"></a>
+
+## Installation
+
+The library itself is available on [PyPI][5] and can therefore be installed
+using common methods like `pip`:
+
+ pip install beamngpy
+
+If you use [Anaconda](https://www.anaconda.com/products/distribution#download-section), you can
+install BeamNGpy from the `conda-forge` channel by:
+
+ conda install beamngpy -c conda-forge
+
+To upgrade, use
+
+ pip install --upgrade beamngpy
+
+if you installed BeamNGpy using `pip` or
+
+ conda update beamngpy -c conda-forge --no-pin
+
+if you installed it using `conda`.
+
+<a name="usage"></a>
+
+## Usage
+
+**DISCLAIMER:** If you are using an older version of `beamngpy` and BeamNG.tech, please follow the
+instructions of the corresponding `README` file (for example, [1.22 instructions](https://github.com/BeamNG/BeamNGpy/tree/v1.22)).
+
+The library can be imported using `import beamngpy`. A short
+usage example setting up a scenario with one vehicle in the West Coast USA map
+that spans the area is:
+
+```python
+from beamngpy import BeamNGpy, Scenario, Vehicle
+
+# Instantiate BeamNGpy instance running the simulator from the given path,
+# communicating over localhost:64256
+bng = BeamNGpy('localhost', 64256, home='/path/to/bng/tech', user='/path/to/bng/tech/userfolder')
+# Launch BeamNG.tech
+bng.open()
+# Create a scenario in west_coast_usa called 'example'
+scenario = Scenario('west_coast_usa', 'example')
+# Create an ETK800 with the licence plate 'PYTHON'
+vehicle = Vehicle('ego_vehicle', model='etk800', license='PYTHON')
+# Add it to our scenario at this position and rotation
+scenario.add_vehicle(vehicle, pos=(-717, 101, 118), rot_quat=(0, 0, 0.3826834, 0.9238795))
+# Place files defining our scenario for the simulator to read
+scenario.make(bng)
+
+# Load and start our scenario
+bng.scenario.load(scenario)
+bng.scenario.start()
+# Make the vehicle's AI span the map
+vehicle.ai.set_mode('span')
+input('Hit enter when done...')
+```
+
+We have a [guide][6] helping you getting started and navigating our collection of examples and
+the documentation of the library is available [here][7].
+
+## Compatibility
+
+BeamNG.tech is not a finished product but is still under development.
+Thus frequent changes on the simulation side are to be expected.
+While the BeamNGpy library maintains compatibility between minor versions for the user, this doesn't extend to the BeamNG.tech side. Not all BeamNGpy versions are compatible with all BeamNG.tech versions.
+Below is a list of compatible BeamNG.tech and BeamNGpy versions.
+However we do not maintain minor versions: bug fixes and new features will only be available for the newest BeamNG.tech and BeamNGpy releases.
+
+| BeamNG.tech version | BeamNGpy version |
+| ------------------- | --------------------------------------------------------- |
+| 0.28 | [1.26](https://github.com/BeamNG/BeamNGpy/tree/v1.26) |
+| 0.27 | [1.25.1](https://github.com/BeamNG/BeamNGpy/tree/v1.25.1) |
+| 0.26 | [1.24](https://github.com/BeamNG/BeamNGpy/tree/v1.24) |
+| 0.25 | [1.23.1](https://github.com/BeamNG/BeamNGpy/tree/v1.23.1) |
+| 0.24 | [1.22](https://github.com/BeamNG/BeamNGpy/tree/v1.22) |
+| 0.23 | [1.21.1](https://github.com/BeamNG/BeamNGpy/tree/v1.21.1) |
+| 0.22 | [1.20](https://github.com/BeamNG/BeamNGpy/tree/v1.20) |
+| 0.21 | [1.19.1](https://github.com/BeamNG/BeamNGpy/tree/v1.19.1) |
+
+## Troubleshooting
+
+This section lists common issues with BeamNGpy in particular. Since this
+library is closely tied to BeamNG.tech and thus BeamNG.drive, it is also
+recommended to consult the documentation on BeamNG.drive here:
+
+[https://documentation.beamng.com/][8]
+
+### BeamNGpy cannot establish a connection
+
+ - Be sure to complete the initial set up step described in the Usage section and to repeat it with every newly released BeamNG.tech version.
+ - Make sure BeamNG.tech and Python are allowed to connect to your current
+ network in Windows Firewall.
+
+### BeamNG.tech quietly fails to launch
+
+- There is a known issue where BeamNG.tech quietly crashes when there is a
+ space in the configured userpath. Until this issue is fixed, it is
+ recommended to either switch to a path that does not contain a space or
+ change the userpath directly in the "startup.ini" file located in the
+ directory of your BeamNG.tech installation.
+
+## Contributions
+
+We always welcome user contributions, be sure to check out our [contribution guidelines][9] first, before starting your work.
+
+[1]: https://beamngpy.readthedocs.io/en/latest/
+[2]: https://register.beamng.tech/
+[3]: mailto:licensing@beamng.gmbh
+[4]: https://store.steampowered.com/app/284160/BeamNGdrive/
+[5]: https://pypi.org/project/beamngpy/
+[6]: https://github.com/BeamNG/BeamNGpy/blob/master/examples/guide.md
+[7]: https://beamngpy.readthedocs.io/en/latest/
+[8]: https://documentation.beamng.com/
+[9]: https://github.com/BeamNG/BeamNGpy/blob/master/contributing.md
+[10]: https://github.com/BeamNG/BeamNGpy/blob/master/examples/feature_overview.ipynb
+[11]: https://beamng.tech/
+ + +%package help +Summary: Development documents and examples for beamngpy +Provides: python3-beamngpy-doc +%description help +# BeamNGpy
+<a href="https://beamngpy.readthedocs.io/en/latest/"><img src="https://github.com/BeamNG/BeamNGpy/raw/master/media/documentation.png" /></a>
+
+**BeamNGpy** is an official library providing a Python API to [BeamNG.tech][11],
+the academia- and industry-oriented fork of the video game [BeamNG.drive][4].
+BeamNGpy and BeamNG.tech are designed to go hand in hand, both being kept up
+to date to support each other's functions, meaning using the latest versions
+of both is recommended.
+
+It allows remote control of the simulation, including vehicles contained in it.
+See [Features](#features) or go through the [Feature Overview][10] Jupyter notebook.
+
+## Table of Contents
+
+ - [Features](#features)
+ - [Prerequisites](#prereqs)
+ - [Installation](#installation)
+ - [Usage](#usage)
+ - [Compatibility](#compatibility)
+ - [Troubleshooting](#troubleshooting)
+
+<a name="features"></a>
+
+## Features
+
+BeamNGpy comes with a wide range of low-level functions to interact with the
+simulation and a few higher-level interfaces that make more complex actions
+easier. Some features to highlight are:
+
+### Remote Control of Vehicles
+
+Each vehicle can be controlled individually and independently during the
+simulation. This includes basic steering inputs, but also controls over
+various lights (headlights, indicators, etc.) or gear shifting.
+
+[Throttle Control.webm](https://user-images.githubusercontent.com/93574498/207164528-2415691f-3aee-478e-91ae-a1a53f733ee6.webm)
+
+[Steering Control.webm](https://user-images.githubusercontent.com/93574498/207164554-3f3d9478-3970-4c08-b1e3-2b656313ae33.webm)
+
+### AI-controlled Vehicles
+
+Besides manual control, BeamNG.tech ships with its own AI to control vehicles.
+This AI can be configured and controlled from BeamNGpy. It can be used to
+make a vehicle drive to a certain waypoint, make it follow another vehicle,
+span the map, or follow a user-defined trajectory:
+
+
+
+### Dynamic Sensor Models
+
+Vehicles and the environment can be equipped with various sensors that provide
+simulated sensor data. These sensors include:
+
+ - Cameras
+ - Color camera
+ - Depth camera
+ - Semantic and Instance annotations
+ - Lidars
+ - Inertial Measurement Units
+ - Ultrasonic Distance Measurements
+
+
+
+
+These sensors give perfect data from the simulation by default. Therefore, some
+of them, like the camera and lidar sensor, can be equipped to also simulate
+noisy data.
+
+### Access to Road Network & Scenario Objects
+
+Geometry of roads in the currently-loaded level/scenario are made available
+via BeamNGpy. Objects and vehicles that are currently active in the scene
+are also exposed, allowing for analysis of the current simulation state.
+
+
+
+### Multiple Clients
+
+BeamNGpy interacts with BeamNG.tech as the client, with BeamNG.tech acting
+as the server. This allows for multiple BeamNGpy processes to connect to a
+running simulation and have each control the simulator, making it possible
+to, for example, [run a scenario in which each vehicle is controlled by
+a separate client.](https://github.com/BeamNG/BeamNGpy/tree/master/examples/multi_client.ipynb)
+
+### More
+
+There is a healthy collection of usage examples in the [examples/](https://github.com/BeamNG/BeamNGpy/tree/master/examples)
+folder of this repository. These highlight more features, but also serve
+as documentation, so be sure to check them out.
+
+<a name="prereqs"></a>
+
+## Prerequisites
+
+Usage of BeamNGpy requires BeamNG.tech to be installed. Builds of
+BeamNG.tech are made available for non-commercial use upon request using
+[this form][2]. For commercial use, contact us at [licensing@beamng.gmbh][3].
+Once downloaded, you can use the environment variable `BNG_HOME` to where
+BeamNG.tech can be run from, or provide a path to the BeamNGpy library
+during initialization.
+
+The regular [Steam release of BeamNG.drive][4] is compatible to an extent as
+well. Certain sensors like the simulated LiDAR or camera will not work, but
+most of the functions that are not exclusive to a Tech build will likely
+work.
+
+<a name="installation"></a>
+
+## Installation
+
+The library itself is available on [PyPI][5] and can therefore be installed
+using common methods like `pip`:
+
+ pip install beamngpy
+
+If you use [Anaconda](https://www.anaconda.com/products/distribution#download-section), you can
+install BeamNGpy from the `conda-forge` channel by:
+
+ conda install beamngpy -c conda-forge
+
+To upgrade, use
+
+ pip install --upgrade beamngpy
+
+if you installed BeamNGpy using `pip` or
+
+ conda update beamngpy -c conda-forge --no-pin
+
+if you installed it using `conda`.
+
+<a name="usage"></a>
+
+## Usage
+
+**DISCLAIMER:** If you are using an older version of `beamngpy` and BeamNG.tech, please follow the
+instructions of the corresponding `README` file (for example, [1.22 instructions](https://github.com/BeamNG/BeamNGpy/tree/v1.22)).
+
+The library can be imported using `import beamngpy`. A short
+usage example setting up a scenario with one vehicle in the West Coast USA map
+that spans the area is:
+
+```python
+from beamngpy import BeamNGpy, Scenario, Vehicle
+
+# Instantiate BeamNGpy instance running the simulator from the given path,
+# communicating over localhost:64256
+bng = BeamNGpy('localhost', 64256, home='/path/to/bng/tech', user='/path/to/bng/tech/userfolder')
+# Launch BeamNG.tech
+bng.open()
+# Create a scenario in west_coast_usa called 'example'
+scenario = Scenario('west_coast_usa', 'example')
+# Create an ETK800 with the licence plate 'PYTHON'
+vehicle = Vehicle('ego_vehicle', model='etk800', license='PYTHON')
+# Add it to our scenario at this position and rotation
+scenario.add_vehicle(vehicle, pos=(-717, 101, 118), rot_quat=(0, 0, 0.3826834, 0.9238795))
+# Place files defining our scenario for the simulator to read
+scenario.make(bng)
+
+# Load and start our scenario
+bng.scenario.load(scenario)
+bng.scenario.start()
+# Make the vehicle's AI span the map
+vehicle.ai.set_mode('span')
+input('Hit enter when done...')
+```
+
+We have a [guide][6] helping you getting started and navigating our collection of examples and
+the documentation of the library is available [here][7].
+
+## Compatibility
+
+BeamNG.tech is not a finished product but is still under development.
+Thus frequent changes on the simulation side are to be expected.
+While the BeamNGpy library maintains compatibility between minor versions for the user, this doesn't extend to the BeamNG.tech side. Not all BeamNGpy versions are compatible with all BeamNG.tech versions.
+Below is a list of compatible BeamNG.tech and BeamNGpy versions.
+However we do not maintain minor versions: bug fixes and new features will only be available for the newest BeamNG.tech and BeamNGpy releases.
+
+| BeamNG.tech version | BeamNGpy version |
+| ------------------- | --------------------------------------------------------- |
+| 0.28 | [1.26](https://github.com/BeamNG/BeamNGpy/tree/v1.26) |
+| 0.27 | [1.25.1](https://github.com/BeamNG/BeamNGpy/tree/v1.25.1) |
+| 0.26 | [1.24](https://github.com/BeamNG/BeamNGpy/tree/v1.24) |
+| 0.25 | [1.23.1](https://github.com/BeamNG/BeamNGpy/tree/v1.23.1) |
+| 0.24 | [1.22](https://github.com/BeamNG/BeamNGpy/tree/v1.22) |
+| 0.23 | [1.21.1](https://github.com/BeamNG/BeamNGpy/tree/v1.21.1) |
+| 0.22 | [1.20](https://github.com/BeamNG/BeamNGpy/tree/v1.20) |
+| 0.21 | [1.19.1](https://github.com/BeamNG/BeamNGpy/tree/v1.19.1) |
+
+## Troubleshooting
+
+This section lists common issues with BeamNGpy in particular. Since this
+library is closely tied to BeamNG.tech and thus BeamNG.drive, it is also
+recommended to consult the documentation on BeamNG.drive here:
+
+[https://documentation.beamng.com/][8]
+
+### BeamNGpy cannot establish a connection
+
+ - Be sure to complete the initial set up step described in the Usage section and to repeat it with every newly released BeamNG.tech version.
+ - Make sure BeamNG.tech and Python are allowed to connect to your current
+ network in Windows Firewall.
+
+### BeamNG.tech quietly fails to launch
+
+- There is a known issue where BeamNG.tech quietly crashes when there is a
+ space in the configured userpath. Until this issue is fixed, it is
+ recommended to either switch to a path that does not contain a space or
+ change the userpath directly in the "startup.ini" file located in the
+ directory of your BeamNG.tech installation.
+
+## Contributions
+
+We always welcome user contributions, be sure to check out our [contribution guidelines][9] first, before starting your work.
+
+[1]: https://beamngpy.readthedocs.io/en/latest/
+[2]: https://register.beamng.tech/
+[3]: mailto:licensing@beamng.gmbh
+[4]: https://store.steampowered.com/app/284160/BeamNGdrive/
+[5]: https://pypi.org/project/beamngpy/
+[6]: https://github.com/BeamNG/BeamNGpy/blob/master/examples/guide.md
+[7]: https://beamngpy.readthedocs.io/en/latest/
+[8]: https://documentation.beamng.com/
+[9]: https://github.com/BeamNG/BeamNGpy/blob/master/contributing.md
+[10]: https://github.com/BeamNG/BeamNGpy/blob/master/examples/feature_overview.ipynb
+[11]: https://beamng.tech/
+ + +%prep +%autosetup -n beamngpy-1.26 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-beamngpy -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Mon May 29 2023 Python_Bot <Python_Bot@openeuler.org> - 1.26-1 +- Package Spec generated |