Automatically generated API python docs using mkdocstrings and example docs #3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
PabloVD
changed the title
|
I have created a separated section for explaining in detail the goals and usage of the 4 example scripts.
|
…mulation (aerosim-open#5) This PR introduces utility scripts designed for testing camera sensor image streams, generating simulation configurations, and executing detect-and-avoid (DAA) simulations involving an EVTOL and multiple fixed-wing intruders. ### Included Scripts #### Camera Stream Utilities - `camera_stream_opencv.py`: Uses OpenCV to visualize real-time camera sensor image streams. - `camera_stream_performance.py`: Measures image stream rate, latency, and compression for performance analysis. #### Scenario Generation - `generate_scenario.py`: Utilizes the `aerosim-scenarios` package to generate simulation configuration and trajectory files from example scenario JSON inputs. #### Alternative DAA Scenario Simulation - `run_flyby_intruders.py`: Executes an EVTOL simulation with five fixed-wing intruders, following predefined trajectories. - `sim_config_flyby_intruders.json`: Configuration file for the flyby intruders scenario. - `mission_waypoint_flyby_intruders.txt`: Waypoints for the EVTOL in the flyby intruders scenario. - Eight trajectory JSON files: `in_1_trajectory.json` through `in_8_trajectory.json`, defining possible flight paths for the intruders. ### Functionality These scripts provide utilities for working with Aerosim-based simulations. They support: - Real-time visualization and performance analysis of camera streams. - Automated scenario generation for simulation configuration and trajectory setup. - Execution of advanced detect-and-avoid simulations, integrating multiple aircraft trajectories. ### Next Steps Ensure proper integration of these scripts within existing simulation workflows and validate functionality across different test scenarios. Co-authored-by: AeroSim Org <[email protected]>
…r Warning (aerosim-open#6) This PR updates the ADSB tutorial to guide users on formatting their own data, adds detailed Unreal Engine download and installation instructions, and adds a note clarifying weather preset limitations in the Omniverse renderer. ### Changes - **ADSB Tutorial Updates:** - Revised `docs/adsb_trajectories_tutorial.md` to remove direct ADSB CSV file references. - Added instructions to format user-provided ADSB data for conversion into an AeroSim trajectory. - **Unreal Engine Installation Guide Enhancements:** - Expanded details on downloading Unreal Engine 5.3 from the Epic Games Store. - Clarified installation steps using the Epic Games Launcher. - Explained GitHub authorization for Unreal Engine 5.3 source code access. - **Omniverse Weather Support Clarification:** - Added a note in `docs/sim_config.md` explaining that Omniverse does not support different weather presets (`Cloudy`, `ClearSky`, `FoggyAndCloudy`). ### Impact - **ADSB Tutorial:** Empowers users to integrate their own ADSB datasets by providing clear formatting guidance. - **Unreal Engine Setup:** Reduces confusion and improves accessibility for users setting up Unreal Engine for AeroSim. - **Omniverse Renderer Documentation:** Sets realistic expectations regarding weather support within Omniverse. ### Testing - Verified the accuracy and usability of the revised ADSB tutorial steps. - Followed Unreal Engine installation instructions to ensure correctness. - Confirmed proper markdown rendering of the Omniverse weather clarification note. Co-authored-by: AeroSim Org <[email protected]>
…im-open#7) This PR introduces two reference implementations to improve simulation data processing and visualization: 1. **Automated Altitude Offset Measurement**: A referencec script (`generate_offset_data.py`) enables querying a region to measure altitude offsets between expected altitudes and the actual rendered Cesium tiles. 2. **XVIZ Server Integration Example**: A reference example (`xviz_server_example.py`) demonstrates how to connect simulation data topics to an XVIZ server for real-time visualization of data streams. ## Changes - **`generate_offset_data.py`**: - Implements a method to query altitude offsets in a specified region. - Uses interpolation techniques to process altitude differences. - Outputs structured data for further analysis. - **`xviz_server_example.py`**: - Provides an example of connecting simulation data topics to an XVIZ server. - Enables visualization of simulation data streams in real time. - **Configuration & Supporting Files**: - Added `generate_offset_data_config.json` for altitude offset measurement setup. - Introduced `offset_map.json` and `sample_expected_altitudes.json` for reference altitude data. - Updated `requirements.txt` to include dependencies for XVIZ integration. ## Impact - **Improves automation** for altitude offset analysis, reducing manual effort. - **Enhances visualization** of simulation data streams via XVIZ. - **Provides structured examples** for users to integrate similar functionality into their workflows. ## Testing - Verified altitude offset measurements against expected values. - Confirmed XVIZ server connection and data visualization functionality. Co-authored-by: AeroSim Org <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Create automatically generated API python documentation using mkdocstrings. This mkdocs extension makes use of docstrings and type annotations in python classes and functions to parse them and automatically generate a documentation.
Styling could be further improved using custom CSS. Also, more docstrings should be included/enhanced in different modules to improve this documentation.
Some of the above modules may not require an API documentation.
aerosim-coreandaerosim-worldmay also be included if needed. Docstrings should be improved in the future for more clear information.Here are some examples: