You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,11 +21,11 @@ Now, we have made a major upgrade to StarPerf, extending its usability and enric
21
21
22
22
Compared with StarPerf 1.0, StarPerf 2.0 is fully implemented in Python and no longer depends on any third-party orbit analysis or computation tools. You only need to ensure that **Python 3.10** or above is installed on your system.
23
23
24
-
##Installation
24
+
# Installation
25
25
26
26
We recommend using [uv](https://github.com/astral-sh/uv), a fast Python package and project manager, to manage dependencies and virtual environments for this project.
For more installation options, please refer to [official uv documentation](https://docs.astral.sh/uv/getting-started/installation/).
46
46
47
-
**Installing Dependencies:**
47
+
**(2) Installing Dependencies:**
48
48
49
49
Once you have cloned the repository, you can install all required dependencies using the following `uv` command:
50
50
@@ -53,9 +53,9 @@ cd StarPerf_Simulator/
53
53
uv sync
54
54
```
55
55
56
-
This will automatically create a virtual environment and install all necessary libraries to ensure the system runs properly.
56
+
This will automatically create a virtual environment and install all necessary libraries.
57
57
58
-
# StarPerf overview and processing flow
58
+
# StarPerf Overview and Processing Flow
59
59
60
60
You can directly run our simulation example using the following command:
61
61
@@ -84,21 +84,21 @@ http-server -p 8081
84
84
85
85
5. Open the constellation visualization webpage by entering `http://127.0.0.1:8081/<filename>` in your browser. Here, `<filename>` refers to the name of the webpage file generated by our visualization code under `/StarPerf_Simulator/visualization/CesiumApp`.
86
86
87
-
# Contributors are more than welcome
87
+
# Contributors Are More Than Welcome
88
88
89
89
Wanna to join the construction of "NewSpace" constellations and networks? Awesome! This project follows the [Github contribution work flow.](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/github-flow) Submissions can fork and use a Github pull request to get merged into this code base.
90
90
91
91
Ways to help are listed as follows.
92
92
93
-
### Bug reports
93
+
### Bug Reports
94
94
95
95
If you come across a bug in using StarPerf, you are more than welcome to file a bug report to our mail box.
96
96
97
-
### Contribute more constellation designs
97
+
### Contribute More Constellation Designs
98
98
99
99
As emerging mega-constellations are still evolving rapidly and constellations such as Starlink and OneWeb are still under heavy development, we welcome all who are interested in this research topic to contribute their innovative designs, documents, insights, comments and suggestions.
100
100
101
-
### Write test cases
101
+
### Write Test Cases
102
102
103
103
Currently this project has not be ''thoroughly''' tested. You are more than welcome to build any test cases for this project.
0 commit comments