Skip to content

Commit

Permalink
feat(docs): Add procedure for DACS SW database ingestion (#46)
Browse files Browse the repository at this point in the history
Co-authored-by: dpoluyanov <[email protected]>
  • Loading branch information
gteufelberger and damcha-eth authored Jun 14, 2024
1 parent c0f51ea commit b2771f8
Show file tree
Hide file tree
Showing 7 changed files with 124 additions and 2 deletions.
59 changes: 59 additions & 0 deletions src/dacs-sw/database-ingestion/sections/ingestion.tex
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,63 @@
\hline
\rowcolor{tableHeaderColor}
ID & CK 1 & Description \\ \hline

\procedureItem{
Locate the rosbags:
\\
They are in the folder (\texttt{catkin\_ws/src/rosbags})
}

\procedureItem{
Copy the rosbags that you need (the specific time of the bags)
}

\procedureItem{
Go to the folder (\texttt{git/datamanagement/database\_pro/bagsvortex/Param\_anal})
}

\procedureItem{
Remove all old rosbags from that specific folder (move them into bagsvortex)
}

\procedureItem{
Paste your new rosbags in there
}

\procedureItem{
Go to the ProDacs config file, which is located in the folder (\texttt{git/configuration\_tests})
}

\procedureItem{
Open it and change the date and time and name of the test to your test, be careful to leave the formatting of the date and time as it is, do not change anything in the format or it will crash the script
}

\procedureItem{
Save it with (\texttt{Ctrl + S}), if a window pops up asking if xlsx or the other format, go with the excel format
}

\procedureItem{
Go to the terminal or terminator, doesnt matter which one
}

\procedureItem{
Type (\texttt{cd git/datamanagment/database\_pro}), this will lead you to the correct directory
}

\procedureItem{
Create a database entry by typing this into the terminal (\texttt{python3 configure\_db.py})
}

\procedureItem{
Check if the date and name are correct, if yes press (\texttt{Y}) if not then go to step number 6 (i.e. the one regarding ProDacs config file)
}

\procedureItem{
Write a brief description of the test so you will understand what it was at a later time
}

\procedureItem{
After the entry was created you can run (\texttt{python3 read\_bag.py}) this will ingest the rosbags into the database entry
}

\end{tabularx}
12 changes: 12 additions & 0 deletions src/dacs-sw/database-ingestion/sections/installation.tex
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,16 @@
\hline
\rowcolor{tableHeaderColor}
ID & CK 1 & Description \\ \hline

\procedureItem{
Set up Mission Control PC (MCPC) by plugging in power, monitor, mouse, keyboard.
}

\procedureItem{
Turn MCPC on.
\\
Login credentials can be found on the DACS software page of the wiki
\\
\texttt{https://wiki.aris-space.ch/e/en/rocketry/engines \\/liquid/test-bench/data-acquisition-and-control-system\\/Subsystems/Software}
}
\end{tabularx}
35 changes: 35 additions & 0 deletions src/dacs-sw/database-ingestion/sections/mysql.tex
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,39 @@
\hline
\rowcolor{tableHeaderColor}
ID & CK 1 & Description \\ \hline
\procedureItem{
All the following commands should be run in the terminal
}

\procedureItem{
Check if database is running. If it isn't, start it by running
\\
\texttt{sudo service start mysql}
}

\procedureItem{
Log into database
\\
\texttt{mysql -u root -p}
}

\procedureItem{
Database password can be found in the wiki
}

\procedureItem{
Select the database
\\
\texttt{USE dacs;}
}

\procedureItem{
Show the recorded tests
\\
\texttt{SELECT * from tests;}
}

\procedureItem{
You should now see all the test entries in the database.
}
\end{tabularx}
2 changes: 1 addition & 1 deletion src/dacs-sw/database-ingestion/sections/notes.tex
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
\hline

\noteItem{
TODO
The whole setup is about to change with moving the database off of the MCPC onto a remote server.
}
\end{tabularx}
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
% Operation description
TODO
Ingest rosbags into database and generate plots
9 changes: 9 additions & 0 deletions src/dacs-sw/database-ingestion/sections/plotting.tex
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,13 @@
\hline
\rowcolor{tableHeaderColor}
ID & CK 1 & Description \\ \hline
\procedureItem{
Head to directory (\texttt{git/datamanagment/database\_pro})
}
\procedureItem{
Run script (\texttt{data\_analysis\_22.py})
}
\procedureItem{
Follow the instructions
}
\end{tabularx}
7 changes: 7 additions & 0 deletions src/dacs-sw/database-ingestion/sections/required-tools.tex
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,11 @@
\hline
\rowcolor{tableHeaderColor}
Check & Amount & Description \\ \hline
\checklistItem{1}{Mission Control PC}
\checklistItem{1}{Monitor}
\checklistItem{1}{Keyboard}
\checklistItem{1}{Mouse}
\checklistItem{2}{Power Adapter for PC}
\checklistItem{1}{Power Strip}
\checklistItem{1}{DP Cable}
\end{tabularx}

0 comments on commit b2771f8

Please sign in to comment.