Metadata-Version: 2.1
Name: neverwhere
Version: 0.0.1rc1
Home-page: https://github.com/embodied-intelligence/neverwhere
Author: Ge Yang<ge.ike.yang@gmail.com>
Author-email: ge.ike.yang@gmail.com
License: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: params-proto >=2.11.16
Requires-Dist: pillow
Requires-Dist: msgpack
Requires-Dist: numpy >=1.21
Requires-Dist: websockets
Provides-Extra: all
Requires-Dist: aiohttp ; extra == 'all'
Requires-Dist: aiohttp-cors ; extra == 'all'
Requires-Dist: killport ; extra == 'all'
Provides-Extra: dev
Requires-Dist: aiohttp ; extra == 'dev'
Requires-Dist: aiohttp-cors ; extra == 'dev'
Requires-Dist: killport ; extra == 'dev'
Requires-Dist: black ==22.3.0 ; extra == 'dev'
Requires-Dist: pylint ==2.13.4 ; extra == 'dev'
Requires-Dist: pytest ==7.1.2 ; extra == 'dev'
Requires-Dist: sphinx ==7.1.2 ; extra == 'dev'
Requires-Dist: furo ; extra == 'dev'
Requires-Dist: sphinx-copybutton ; extra == 'dev'
Requires-Dist: myst-parser ; extra == 'dev'
Requires-Dist: trimesh ; extra == 'dev'
Requires-Dist: tqdm ; extra == 'dev'
Provides-Extra: example
Requires-Dist: aiohttp ; extra == 'example'
Requires-Dist: aiohttp-cors ; extra == 'example'
Requires-Dist: killport ; extra == 'example'
Requires-Dist: open3d <0.16.0,>=0.15.0 ; extra == 'example'
Requires-Dist: trimesh ; extra == 'example'
Requires-Dist: cmx ; extra == 'example'
Requires-Dist: functional-notations ; extra == 'example'
Requires-Dist: ml-logger ; extra == 'example'
Requires-Dist: opencv-python ; extra == 'example'

<h2>neverwhere: Hyper-Realistic Visual Locomotion Benchmark
<br/>
<a href="https://pypi.org/project/neverwhere/">
<img src="https://img.shields.io/pypi/v/neverwhere.svg" alt="pypi">
</a>
<a href="https://docs.neverwhere.ai">
<img src="https://readthedocs.org/projects/neverwhere/badge/?version=latest">
</a>
</h2>
<p>
<strong><code>pip install neverwhere</code></strong>
&nbsp;&nbsp;⬝&nbsp;&nbsp;
visit &ensp;<a href="https://neverwhere.readthedocs.org">https://neverwhere.readthedocs.org</a>&ensp; for documentation
</p>

neverwhere is a hyper realistic visual benchmark for legged locomotion.

## Installation

You can install `neverwhere` with `pip`:

```shell
pip install -U 'neverwhere[all]'
```

- [ ] add setup for the dataset.

Here is an example that loads a URDF file and displays it in the browser. For a more comprehensive list of examples, please refer to
the [examples](https://docs.neverwhere.ai/en/latest/examples/01_trimesh.html) page.

```python
from neverwhere import make

env = make("Cones-BCS-v1")

env.reset()
for _ in range(1000):
    random_action = env.action_space.sample()
    env.step(random_action)
    ego_view = env.render("rgb_array")
```

To get a quick overview of what you can do with `neverwhere`, check out the following:

- take a look at the example gallery [here](https://docs.neverwhere.ai/en/latest/examples/01_trimesh.html)
- or try to take a look at this demo with a Unitree Go1 robot in front of a flight of
  stairs [here](https://docs.neverwhere.ai/en/latest/tutorials/robotics/urdf_go1_stairs.html)

For a comprehensive list of visualization components, please refer to
the [API documentation on Components](https://docs.neverwhere.ai/en/latest/api/neverwhere.html).

For a comprehensive list of data types, please refer to
the [API documentation on Data Types](https://docs.neverwhere.ai/en/latest/api/types.html).

## Contributing to Documentation and Features

Documentation is a crucial part of the `neverwhere` ecosystem. To contribute to documentation and usage examples, simply:

```bash
pip install -e '.[all]'
make docs
```

This should fire up an http server at the port `8888`, and you can view the documentation at `http://localhost:8888`.

## About Us

neverwhere is built by researchers at MIT and UCSD in fields including robotics, computer vision, and computer graphics.

