Getting Started

Setting up the conda environment:

conda create -n neverwhere python=3.8
conda activate neverwhere

Now install the latest version (0.0.1-rc1) on pypi.

pip install -U 'neverwhere[all]==0.0.1-rc1'

You can test the environment by running the following example:

from neverwhere import neverwhere

env = neverwhere.make("Env-name-v1")
obs = env.reset()
done = False

while not done:
    # randomly sample an action
    act = env.action_space.sample()
  
    obs, reward, done, info = env.step()

For list of environments, refer to ./environments

Developing (Optional)

If you want to develop neverwhere, follow the you can install it in editable mode plus dependencies relevant for building the documentations:

cd neverwhere
pip install -e '.[all]'

To view the documentations, you can run the sphinx-autobuild tool which watches the current docs directory for changes and refreshes the webpage upon source change.

make preview

To view a static build,

make docs