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
+30-22Lines changed: 30 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,38 +21,46 @@ 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
-
You can install all required dependencies at once using the following commands:
24
+
## Installation
25
+
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
+
47
+
**Installing Dependencies:**
48
+
49
+
Once you have cloned the repository, you can install all required dependencies using the following `uv` command:
25
50
26
51
```bash
27
-
cd StarPerf_Simulator
28
-
pip install -r requirements.txt
52
+
cd StarPerf_Simulator/
53
+
uv sync
29
54
```
30
55
31
-
This will automatically install all necessary libraries to ensure the system runs properly. Specifically, we used the following packages to support the simulation:
32
-
33
-
- h3==4.0.0b2
34
-
- h5py==3.10.0
35
-
- numpy==1.24.4
36
-
- openpyxl==3.1.2
37
-
- importlib-metadata==6.8.0
38
-
- skyfield==1.46
39
-
- sgp4==2.22
40
-
- pandas==2.1.0
41
-
- poliastro==0.17.0
42
-
- astropy==5.3.3
43
-
- networkx==3.1
44
-
- requests==2.31.0
45
-
- jenkspy==0.4.0
46
-
- pyecharts==2.0.4
47
-
- global_land_mask==1.0.0
48
-
- ephem==4.2
56
+
This will automatically create a virtual environment and install all necessary libraries to ensure the system runs properly.
49
57
50
58
# StarPerf overview and processing flow
51
59
52
60
You can directly run our simulation example using the following command:
53
61
54
62
```bash
55
-
python3 StarPerf.py
63
+
uv run python StarPerf.py
56
64
```
57
65
58
66
Of course, you can also write your own simulation scripts. For specific guidelines and important notes, please refer to [interface\_convention](./docs/interface_convention.pdf).
0 commit comments