Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added instructions on workarounds for installing palpy and skybright libraries
Added instructions to install models from stable baselines3 contrib like recurrent PPO
Added instructions to run evaluations on saved checkpoints
  • Loading branch information
rhea05 authored Sep 23, 2023
1 parent 84fa58d commit 0a2fdc1
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@

![status](https://img.shields.io/badge/License-MIT-lightgrey)

# This branch has been tested with Python 3.9

# Summary

This repo is a stripped down version of the main [RLTelescope](https://github.com/deepskies/RLTelescopes); containing just the positioning simulation.
Expand Down Expand Up @@ -34,6 +36,25 @@ Otherwise, you can use the `pyproject.toml` with your installer of choice.

To verify all the depedencies are properly installed - run `python run pytest`.

## Install palpy and skybright from source

## Workaround to Install palpy
Install from source repository
Modify setup.py with the following changes
#sources = ["cpal.pxd", "pal.pyx"]
sources = ["pal.pyx"]

## Workaround for skybright

convert fit_sky.py from Python2 to Python3

missing apt_pkg.so fix
$ sudo cp apt_pkg.cpython-38-x86_64-linux-gnu.so /usr/lib/python3/dist-packages/apt_pkg.so

## Installation of stablebaselines3 Recurrent PPO

pip install sb3-contrib

# Example:

## To run as a live envoriment for RL
Expand Down Expand Up @@ -81,6 +102,14 @@ observations = env()
```

## Evaluate Checkpoints

run the model_test_xxx.py script

Example: Load a PPO checkpoint
model_path = f"{models_dir}/710000.zip" # NEED TO CHANGE PATH FOR CHECKPOIN
model = PPO.load(model_path, env=env)


# Acknowledgement
And you <3
Expand Down

0 comments on commit 0a2fdc1

Please sign in to comment.