rewrite README
This commit is contained in:
Danila Gamkov
parent
801d4563b2
commit
73dc701536
141
README.markdown
141
README.markdown
@ -1,68 +1,133 @@
|
||||
# asotr_flight
|
||||
# mvn_flight
|
||||
|
||||
The asotr_flight python scripts is designed to analyze ASOTR flight data
|
||||
This project contains tools for decoding, converting, and visualizing telemetry data from the MVN. It includes utilities for unpacking binary archives, converting them to CSV, and generating plots for selected time intervals.
|
||||
|
||||
## Contents
|
||||
|
||||
- **Setup**
|
||||
- **Using**
|
||||
- Plot ASOTR data in specified date borders (for MVN reports)
|
||||
- **Project structure**
|
||||
- **Requirements**
|
||||
- ** Linux Setup**
|
||||
- ** Windows 10 Setup**
|
||||
- **Using the tools**
|
||||
- *Plot all ASOTR data*
|
||||
- *Plot ASOTR data in specified date borders (for MVN reports)*
|
||||
- **Contacts**
|
||||
|
||||
**Note**: \<PATH_TO_ASOTR_FLIGHT\> - path where is asotr_flight scripts is cloned from heagit
|
||||
**Note**: \<PATH_TO_ASOTR_CSV\> - path where is asotr_csv program is cloned from heagit
|
||||
**Note 1**: \<PATH_TO_MVN_FLIGHT\> - path where is mvn_flight scripts is cloned from heagit
|
||||
**Note 2**: \<PATH_TO_ASOTR_DATA\> - path with raw MVN ASOTR data
|
||||
**Note 3**: \<PATH_TO_MVN_DATA\> - path with raw MVN data
|
||||
|
||||
## Setup
|
||||
1. Install python 3.10 or newest.
|
||||
## Project structure
|
||||
-> `/bin/` - ready-to-use binary files and python scripts for assembling, extracting and plotting telemetry data
|
||||
--> `/bin/asotr_unzip_plot.sh` or `/bin/asotr_unzip_plot.bat` — scripts to automate the unpack-convert-plot chain for Linux/Windows.
|
||||
--> `/bin/plot_flight_borders.py` — Python script to generate plots from CSV data.
|
||||
-> `/asotr_csv/` — binary parser to collect data from raw ASOTR data to CSV. This parser written using the Rust language. For more informatin see documentation in `/asotr_csv/README.markdown`).
|
||||
-> `/data/` — folder containing processed CSV files.
|
||||
-> `/plots/` — folder where output plots are saved.
|
||||
|
||||
2. Clone the repo to your computer:
|
||||
```
|
||||
git clone http://heagit.cosmos.ru/gamkov/asotr_flight.git
|
||||
## Requirements
|
||||
- Python version 3.10 or upper. For checking type:
|
||||
```bash
|
||||
python3 --version
|
||||
```
|
||||
|
||||
3. Enter the repo:
|
||||
```
|
||||
cd <PATH_TO_ASOTR_FLIGHT>
|
||||
mkdir reports
|
||||
Python dependencies:
|
||||
```bash
|
||||
pip install matplotlib pandas
|
||||
```
|
||||
|
||||
## Using
|
||||
### Plot ASOTR data in specified date borders (for MVN reports)
|
||||
- Rust compiler version 1.83.0 or upper. For checking type:
|
||||
```bash
|
||||
rustc --version
|
||||
```
|
||||
|
||||
Additional tools (Linux only):
|
||||
```bash
|
||||
sudo apt install unzip git
|
||||
```
|
||||
|
||||
## Linux Setup
|
||||
1. Clone the repo to your computer:
|
||||
```bash
|
||||
git clone http://heagit.cosmos.ru/gamkov/mvn_flight.git
|
||||
```
|
||||
|
||||
2. Install python and python libraries (if you don't have):
|
||||
```bash
|
||||
sudo apt update
|
||||
sudo apt install python3 python3-pip
|
||||
pip3 install matplotlib pandas
|
||||
```
|
||||
|
||||
1. Install Rust compiler (if you do not have):
|
||||
```bash
|
||||
curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh
|
||||
```
|
||||
|
||||
## Windows 10 Setup
|
||||
1. Clone the repo to your computer:
|
||||
```cmd
|
||||
git clone http://heagit.cosmos.ru/gamkov/mvn_flight.git
|
||||
```
|
||||
|
||||
2. Install Python from https://www.python.org/downloads/
|
||||
|
||||
3. Open CMD and install python dependencies:
|
||||
```cmd
|
||||
pip install matplotlib pandas
|
||||
```
|
||||
|
||||
4. Install Rust compiler (if you do not have):
|
||||
Go to address https://www.rust-lang.org/tools/install and follow instructions
|
||||
For more detailed information you can go to: https://doc.rust-lang.ru/book/ch01-01-installation.html
|
||||
|
||||
|
||||
## Using the tools
|
||||
|
||||
### Plot all ASOTR data
|
||||
1. Donwload data from science data server to directory \<PATH_TO_ASOTR_DATA\>.
|
||||
If you don't have MVN data, you might download it from server with science SRG data (IP: 193.232.11.95).
|
||||
For questions about downloading science data contact Shtykovsky A. (a.shtykovsky@cosmos.ru) or Chelovekov I. (chelovekov@cosmos.ru)
|
||||
|
||||
2. Parse all raw data from ASOTR into csv files and plot all csv data:
|
||||
|
||||
Linux:
|
||||
```bash
|
||||
./bin/asotr_unzip_plot.sh <PATH_TO_ASOTR_DATA>/
|
||||
```
|
||||
cd <PATH_TO_ASOTR_CSV>
|
||||
./asotr_all_unzip_auto.sh <PATH_TO_ASOTR_DATA>/
|
||||
|
||||
Windows:
|
||||
```cmd
|
||||
.\bin\asotr_unzip_plot.bat <PATH_TO_ASOTR_DATA>\
|
||||
```
|
||||
|
||||
csv data will be in directory:
|
||||
```cmd
|
||||
./data/asotr/
|
||||
```
|
||||
<PATH_TO_ASOTR_CSV>/data/
|
||||
```
|
||||
|
||||
### Plot ASOTR data in specified date borders (for MVN reports)
|
||||
1-2. See previous chapter (``Plot all ASOTR data``)
|
||||
|
||||
3. plot ASOTR data in specified data borders
|
||||
You might plot data by using shell-script (for MVN reports), for example:
|
||||
|
||||
Linux:
|
||||
```bash
|
||||
./bin/plot_flight_borders.sh ../data/asotr/ 10.03.2025_00:00:00 23.04.2025_23:59:59
|
||||
```
|
||||
cd <PATH_TO_ASOTR_FLIGHT>
|
||||
./plot_flight_borders.sh <PATH_TO_ASOTR_CSV>/data/ 10.03.2025 23.04.2025 14 0
|
||||
|
||||
Windows:
|
||||
```cmd
|
||||
.\bin\plot_flight_borders.bat ..\data\asotr\ 10.03.2025_00:00:00 23.04.2025_23:59:59
|
||||
```
|
||||
|
||||
where:
|
||||
10.03.2025 - start date
|
||||
23.04.2025 - end date
|
||||
14 - font size for plot
|
||||
0 - display commands flag (not display)
|
||||
10.03.2025_00:00:00 - start date_time
|
||||
23.04.2025_23:59:59 - end date_time
|
||||
|
||||
Or you might plot data by using python script directly, for example:
|
||||
```
|
||||
cd <PATH_TO_ASOTR_FLIGHT>
|
||||
python3 plot_flight_borders.py -s <PATH_TO_ASOTR_CSV>/data/ -c 100000 -a 01 -b 10.03.2025 -e 15.03.2025 -f 14 -d 0 -p 0
|
||||
```
|
||||
|
||||
Graphs with data are in the directory:
|
||||
```
|
||||
<PATH_TO_ASOTR_FLIGHT>/reports
|
||||
plots with data are in the directory:
|
||||
```cmd
|
||||
/plots/reports
|
||||
```
|
||||
|
||||
## Contatcs
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user