Skip to content

Commit

Permalink
README updates, setup.py fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
micmarty-deepsense committed Apr 30, 2020
1 parent 56f7ee6 commit df80460
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,23 +46,25 @@ Make sure that `PYTHONPATH` env variable contains CARLA distribution egg, so tha
python PythonAPI/util/config.py --no-rendering

# Preview while cruising on autopilot (birdview/__main__.py)
birdview-demo
python -m carla_birdeye_view
```

### Basic code usage

```python
from carla_birdeye_view import BirdViewProducer
from carla_birdeye_view import BirdViewProducer, PixelDimensions

birdview_producer = BirdViewProducer(
client,
target_size=PixelDimensions(width=birdview.DEFAULT_WIDTH, height=birdview.DEFAULT_HEIGHT),
client, # carla.Client
target_size=PixelDimensions(width=150, height=336),
pixels_per_meter=4,
)

# Input for your model - call it every simulation step
# returned result is np.ndarray with ones and zeros of shape (8, height, width)
birdview = birdview_producer.produce(agent_vehicle=agent)
birdview = birdview_producer.produce(
agent_vehicle=agent # carla.Actor (spawned vehicle)
)

# Use only if you want to visualize
# produces np.ndarray of shape (height, width, 3)
Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

setup(
name="carla-birdeye-view",
version="1.0.12",
version="1.0.14",
description="Bird-eye's view for CARLA simulator",
keywords=["CARLA", "birdview", "bird-eye's view", "Reinforcement Learning", "RL"],
long_description=README,
Expand All @@ -23,7 +23,7 @@
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8,"
"Programming Language :: Python :: 3.8"
],
include_package_data=True,
install_requires=REQUIREMENTS,
Expand Down

0 comments on commit df80460

Please sign in to comment.