Skip to content

Commit

Permalink
Updated README file (space-ros#46)
Browse files Browse the repository at this point in the history
  • Loading branch information
jchaudhary21 authored and mkhansenbot committed Sep 9, 2024
1 parent 3890c75 commit 6f57eee
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 13 deletions.
39 changes: 26 additions & 13 deletions custom_gz_plugins/src/DayLightManager/README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,39 @@
# Day Light Managers Plugin
# Daylight Manager Plugin

The Sun is the driving force behind most planetary phenomena, influencing nearly every aspect of the environment, either directly or indirectly. Accurately simulating the Sun's path is crucial for realistic environmental modeling, especially in intricate scenarios.
The Sun plays a pivotal role in driving most planetary phenomena, influencing nearly every environmental aspect, directly or indirectly. Accurately modeling the Sun's path is essential for realistic environmental simulations, especially in complex scenarios.

## Key Features
The Daylight Manager plugin for Gazebo simulates the Sun's trajectory based on the time of day and the observer's latitude, providing a realistic and dynamic representation of sunlight. The shadow of object changes depending on the Sun's position, as depicted below

The Day Light Managers plugin for Gazebo simulates the Sun's trajectory based on the time of day and the observer's latitude.
![Sun Trajectory Simulation](../assets/day_light_manager_transition.gif)

![Sun Trajectory Simulation](path_to_gif.gif)
# Features:
1. Sun Trajectory Variation:

The key factors determining the Sun's path include:
- **Time of Day**: The Sun's altitude varies throughout the day.
- **Latitude**: The observer's latitude affects the solar altitude.
- **Time of Day**: The Sun’s altitude changes throughout the day, and users can set a custom time to observe these variations.
- **Latitude**: The observer's latitude influences solar altitude, and users can customize the latitude to adjust the Sun’s path accordingly. Below is an gif of the Sun's trajectory at -80° latitude on Earth. ( Right gif reference : https://andrewmarsh.com/apps/staging/sunpath3d.html )

![Sun Trajectory Simulation Latitude](../assets/day_light_manager_transition_latitude_merge.gif)


## Visual Demonstration
2. **Live Time Update**: Real-time updates are displayed in the GUI.

As the Sun's altitude changes, the simulation's background color dynamically adjusts to reflect the lighting conditions.
3. **Adjustable Sun Position**: Users can modify the Sun's position with x and y offsets.

![Background Color Changes](path_to_image.png)
4. **Dynamic Lighting**: As the Sun's altitude changes, the simulation's background color dynamically adjusts to reflect different lighting conditions.

5. **Multi-Planet Support**: The plugin supports Sun trajectories for both Earth and Mars, allowing users to switch between them.

## Usage
6. **Adjustable Rotation Radius**: The radius of the Sun's rotation can be modified using a radius spin box.

Users can accelerate the Sun's trajectory simulation by up to 100x and adjust the Sun's position using x and y offsets.
7. **Simulation Speed Control**: The Sun trajectory simulation speed can be accelerated up to 100x.


# GUI
<img src="../assets/GUI.png" alt="Sun Trajectory GUI" width="50%">


### Refs :
1. https://andrewmarsh.com/apps/staging/sunpath3d.html
2. https://ntrs.nasa.gov/api/citations/20200003207/downloads/20200003207.pdf
3. https://stackoverflow.com/questions/8708048/position-of-the-sun-given-time-of-day-latitude-and-longitude
4. https://ntrs.nasa.gov/api/citations/19940010257/downloads/19940010257.pdf
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6f57eee

Please sign in to comment.