wouter/Artemis
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated docs

Browse Source
This commit is contained in:
Marco Dalla Tiezza
2024-06-14 21:33:42 +02:00
parent c803a72489
commit ebda950c87
1 changed files with 60 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
docs/basic_operations.md
View File

@@ -5,21 +5,58 @@
## 1. Main Menu ## 1. Main Menu
### File ### File
* **New Database:** Create a new database.
* **Load Database:** Open the Database Manager windows in order to open, rename, or delete a database. * **New Database**
* **Import Database:** Import an Artemis database with a standard .tar format.
* **Export Database:** Export the loaded database with a standard .tar format. Create a new database.
* **Edit Tags:** Open the tags editor window. From here, you can add, rename, or delete tags. The tags can be added to a signal from the [tags menu](#4-tags)
* **Open Database Folder:** Shows the folder of the currently loaded database in the explorer. * **Load Database**
* **Preferences:** Open the program settings window.
* **Exit:** This will close the application. Open the Database Manager windows in order to open, rename, or delete a database.
* **Import Database**
Import an Artemis database with a standard .tar format.
!!! tip "Offline Importing of SigID Database"
Sometimes it may happen that a computer does not have network access and unfortunately Artemis cannot download the SigID database. To solve this you can:
1. Download the .tar database [:material-download: HERE](https://github.com/AresValley/Artemis-DB/releases) from a PC with an internet access
2. Import the downloaded .tar on the target PC (without internet access) using the **Import Database** function
* **Export Database**
Export the loaded database with a standard .tar format.
* **Edit Tags**
Open the tags editor window. From here, you can add, rename, or delete tags. The tags can be added to a signal from the [tags menu](#4-tags)
* **Open Database Folder**
Shows the folder of the currently loaded database in the explorer.
* **Preferences**
Open the program settings window.
* **Exit**
This will close the application.
### Signal ### Signal
* **New:** Add a new signal to the database. * **New**
* **Edit:** Edit the current/selected signal from the loaded database.
Add a new signal to the database.
* **Edit**
Edit the current/selected signal from the loaded database.
### Space Weather ### Space Weather
* **Check Report:** Open the main [Space Weather window](space_weather/current.md) and retrieve all the live data from Poseidon Crawler.
* **Check Report**
Open the main [Space Weather window](space_weather/current.md) and retrieve all the live data from Poseidon Crawler.
## 2. Signal List ## 2. Signal List
This is the signal list where all the database entries are shown. When a signal is selected, it will load on the right panel. This is the signal list where all the database entries are shown. When a signal is selected, it will load on the right panel.
@@ -31,9 +68,18 @@ On top of the list, there is a field for filtering signals by name or any keywor
Here you can swithc between the main **signal** window and the **filter** page. Here you can swithc between the main **signal** window and the **filter** page.
## 4. Tags ## 4. Tags
* **Associate Tag:** Custom tags can be associated to the selected signal with the :octicons-plus-circle-16: icon
* **Remove Tag:** In order to remove a tag, just click on its badge. * **Associate Tag**
* **Add/Rename Tag:** To add a new tag open the [Tags Editor](#1-main-menu) in the main menu.
Custom tags can be associated to the selected signal with the :octicons-plus-circle-16: icon
* **Remove Tag**
In order to remove a tag, just click on its badge.
* **Add/Rename Tag**
To add a new tag open the [Tags Editor](#1-main-menu) in the main menu.
## 5. Add Parameter ## 5. Add Parameter
Click on the labels to add the corresponding parameter to the signal (e.g. click on **Frequency** to add a new frequency). Click on the labels to add the corresponding parameter to the signal (e.g. click on **Frequency** to add a new frequency).