Skip to content

Commit 5be24a9

Browse files
root-hbxroot-hbx
committed
feat: webpage for starperf2.0
1 parent fe5645f commit 5be24a9

92 files changed

Lines changed: 4321 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎book/src/README.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# StarPerf: Emerging Mega-Constellations LEO Network Performance Simulator
2+
3+
Welcome to the StarPerf documentation! This comprehensive guide will help you understand and use StarPerf, a powerful platform for simulating and analyzing the network performance of mega-constellation satellite networks such as Starlink and OneWeb.
4+
5+
## What is StarPerf?
6+
7+
"Newspace" mega-constellations are gaining tremendous popularity, with the promising potential to provide high-capacity and low-latency communication globally. StarPerf enables constellation manufacturers and content providers to estimate and understand the achievable performance under a variety of constellation options.
8+
9+
## Key Features
10+
11+
StarPerf integrates four key techniques:
12+
13+
1. **Performance Simulation for Mega-Constellation**
14+
- Captures the impact of inherent high mobility in satellite networks and profiles area-to-area attainable network performance
15+
16+
2. **Constellation Scaling**
17+
- Synthesizes various topological options by scaling space resources (e.g., number of satellites, link availability and capacity)
18+
19+
3. **Constellation Visualization**
20+
- Leverages Cesium to render mainstream LEO constellations in a highly interactive and realistic 3D environment
21+
22+
4. **Security Simulation**
23+
- Based on attack modeling and numerical simulation, including traffic plugins and communication energy consumption plugins
24+
25+
## StarPerf 2.0
26+
27+
StarPerf 2.0 represents a major upgrade from version 1.0:
28+
29+
- **Pure Python Implementation**: No longer depends on third-party orbit analysis tools (STK, GMAT)
30+
- **Framework + Plugin Architecture**: Highly extensible and modular design
31+
- **Enhanced Functionality**: Richer features and improved usability
32+
- **Python 3.10+ Required**: Modern Python environment
33+
34+
## QuickStart
35+
36+
- [Getting Started](./getting-started/overview.md) - Learn the basics and get up and running
37+
- [Installation Guide](./getting-started/installation.md) - Set up your environment
38+
- [Architecture Overview](./user-guide/architecture.md) - Understand the system design
39+
- [API Reference](./api-reference/introduction.md) - Detailed interface documentation
40+
- [Examples](./examples/overview.md) - Practical usage examples
41+
42+
## Contact
43+
44+
If you have any questions about StarPerf, please don't hesitate to contact us:
45+
46+
- Email: zeqilai AT tsinghua.edu.cn
47+
- Email: houyn24 AT mails.tsinghua.edu.cn
48+
- Email: ZhifengHan AT mail.com
49+
- Email: lijh19 AT mails.tsinghua.edu.cn
50+
51+
Happy benchmarking your constellation! 🛰️

‎book/src/SUMMARY.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
# Summary
2+
3+
[Introduction](./README.md)
4+
5+
# Getting Started
6+
7+
- [Overview](./getting-started/overview.md)
8+
- [Installation](./getting-started/installation.md)
9+
- [Quick Start](./getting-started/quick-start.md)
10+
11+
# User Guide
12+
13+
- [Introduction](./user-guide/introduction.md)
14+
- [Environment & Dependencies](./user-guide/environment.md)
15+
- [Architecture](./user-guide/architecture.md)
16+
- [Configuration Module](./user-guide/configuration.md)
17+
- [H5 File Format](./user-guide/config/h5-format.md)
18+
- [TLE Constellation](./user-guide/config/tle-constellation.md)
19+
- [XML Constellation](./user-guide/config/xml-constellation.md)
20+
- [Ground Stations](./user-guide/config/ground-stations.md)
21+
- [POPs](./user-guide/config/pops.md)
22+
- [Data Storage Module](./user-guide/data-storage.md)
23+
- [Auxiliary Scripts](./user-guide/auxiliary-scripts.md)
24+
25+
# Core Modules
26+
27+
- [Kernel Module Overview](./core-modules/overview.md)
28+
29+
## Constellation Generation
30+
31+
- [Overview](./core-modules/constellation-generation/overview.md)
32+
- [XML-based Generation](./core-modules/constellation-generation/xml-based.md)
33+
- [constellation_configuration.py](./core-modules/constellation-generation/xml-constellation-config.md)
34+
- [orbit_configuration.py](./core-modules/constellation-generation/xml-orbit-config.md)
35+
- [Case Study](./core-modules/constellation-generation/xml-case-study.md)
36+
- [TLE-based Generation](./core-modules/constellation-generation/tle-based.md)
37+
- [download_TLE_data.py](./core-modules/constellation-generation/tle-download.md)
38+
- [satellite_to_shell_mapping.py](./core-modules/constellation-generation/tle-shell-mapping.md)
39+
- [satellite_to_orbit_mapping.py](./core-modules/constellation-generation/tle-orbit-mapping.md)
40+
- [get_satellite_position.py](./core-modules/constellation-generation/tle-position.md)
41+
- [constellation_configuration.py](./core-modules/constellation-generation/tle-constellation-config.md)
42+
- [Case Study](./core-modules/constellation-generation/tle-case-study.md)
43+
- [Duration-based Generation](./core-modules/constellation-generation/duration-based.md)
44+
45+
## Standalone Modules
46+
47+
- [Satellite Visibility Time](./core-modules/standalone-modules/satellite-visibility.md)
48+
49+
## Beam Placement
50+
51+
- [Overview](./core-modules/beam-placement/overview.md)
52+
- [Plugin Specification](./core-modules/beam-placement/plugins.md)
53+
- [Framework](./core-modules/beam-placement/framework.md)
54+
- [Case Study](./core-modules/beam-placement/case-study.md)
55+
56+
## Connectivity
57+
58+
- [Overview](./core-modules/connectivity/overview.md)
59+
- [Plugin Specification](./core-modules/connectivity/plugins.md)
60+
- [Framework](./core-modules/connectivity/framework.md)
61+
- [Case Study](./core-modules/connectivity/case-study.md)
62+
63+
## Performance Evaluation
64+
65+
- [Overview](./core-modules/evaluation/overview.md)
66+
- [With ISL](./core-modules/evaluation/with-isl.md)
67+
- [Bandwidth](./core-modules/evaluation/isl-bandwidth.md)
68+
- [Betweenness](./core-modules/evaluation/isl-betweenness.md)
69+
- [Coverage](./core-modules/evaluation/isl-coverage.md)
70+
- [Delay](./core-modules/evaluation/isl-delay.md)
71+
- [Without ISL (Bent-pipe)](./core-modules/evaluation/without-isl.md)
72+
- [Bandwidth](./core-modules/evaluation/bentpipe-bandwidth.md)
73+
- [Coverage](./core-modules/evaluation/bentpipe-coverage.md)
74+
- [Delay](./core-modules/evaluation/bentpipe-delay.md)
75+
76+
## Entity Classes
77+
78+
- [Overview](./core-modules/entity/overview.md)
79+
80+
## Routing
81+
82+
- [Overview](./core-modules/routing/overview.md)
83+
- [Plugin Specification](./core-modules/routing/plugins.md)
84+
- [Framework](./core-modules/routing/framework.md)
85+
86+
## High Survivability
87+
88+
- [Overview](./core-modules/survivability/overview.md)
89+
- [Plugin Specification](./core-modules/survivability/plugins.md)
90+
- [Framework](./core-modules/survivability/framework.md)
91+
92+
# Visualization
93+
94+
- [Constellation Visualization](./visualization/constellation.md)
95+
- [Setup Instructions](./visualization/setup.md)
96+
97+
# Examples
98+
99+
- [Overview](./examples/overview.md)
100+
- [XML Constellation Example](./examples/xml-constellation.md)
101+
- [TLE Constellation Example](./examples/tle-constellation.md)
102+
- [Beam Placement Example](./examples/beam-placement.md)
103+
- [Connectivity Example](./examples/connectivity.md)
104+
- [Performance Evaluation Example](./examples/evaluation.md)
105+
106+
# API Reference
107+
108+
- [Introduction](./api-reference/introduction.md)
109+
- [Plugin Interfaces](./api-reference/plugin-interfaces.md)
110+
- [Entity Classes](./api-reference/entities.md)
111+
- [Utility Functions](./api-reference/utilities.md)
112+
113+
# Contributing
114+
115+
- [How to Contribute](./contributing/how-to-contribute.md)
116+
- [Writing Plugins](./contributing/writing-plugins.md)
117+
- [Code Style Guide](./contributing/code-style.md)
118+
119+
# About
120+
121+
- [License](./about/license.md)
122+
- [Contact](./about/contact.md)
123+
- [Contributors](./about/contributors.md)

0 commit comments

Comments
 (0)