Metadata-Version: 2.1
Name: gym-novel-gridworlds
Version: 1.0
Summary: Gym Novel Gridworlds are environments for OpenAI Gym
Home-page: https://github.com/gtatiya/gym-novel-gridworlds
Author: Gyan Tatiya
Author-email: Gyan.Tatiya@tufts.edu
License: MIT License
Description: # Gym Novel Gridworlds
        
        Gym Novel Gridworlds are environments for [OpenAI Gym](https://github.com/openai/gym).
        
        ## Installation
        ```
        git clone https://github.com/gtatiya/gym-novel-gridworlds.git
        cd gym-novel-gridworlds
        pip install -e .
        ```
        ## Development Environment
        
        `Python 3.7.4` and following packages were used for development:<br><br>
        
        ### Python Packages
        ```
        pip install gym==0.17.2
        pip install keyboard==0.13.4
        pip install matplotlib==3.1.2
        pip install numpy==1.16.5
        pip install stable_baselines=2.10.0
        pip install tensorflow-gpu==1.14.0
        ```
        
        ## Running
        ```
        import gym
        import gym_novel_gridworlds
        
        env = gym.make('NovelGridworld-v0')
        
        done = False
        while not done:
                env.render()
                action = env.action_space.sample()
                obs, reward, done, info = env.step(action)
        
        env.close()
        ```
        
        ## Enjoy a Trained Agent
        
        If the trained agent exists, then you can see it in action using:
        ```
        python enjoy.py -algo algo_name --env env_id
        ```
        
        For example, enjoy PPO2 on NovelGridworld-v0 during 10 episodes:
        ```
        python enjoy.py -env NovelGridworld-v0 -algo ppo2 -episodes 10
        ```
        
        ## [Environments](https://github.com/gtatiya/gym-novel-gridworlds/wiki#environments)
        
        <table>
        <tr>
        <td>
        <a href="https://github.com/gtatiya/gym-novel-gridworlds/wiki#novelgridworld-v0">NovelGridworld-v0</a>
        <img src="pics/NovelGridworld-v0.gif" alt="drawing" width="800" height="250"/>
        </td>
        <td>
        NovelGridworld-v1<br/>
        <img src="pics/NovelGridworld-v1.gif" alt="drawing" width="800" height="250"/>
        </td>
        </tr>
        </table>
        
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
