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

Merge branch 'change_readme'

Browse Source
This commit is contained in:
alessandro90
2019-07-08 21:35:59 +02:00
parent 760da3d279 7f08e2c9d9
commit 2fd0691764
2 changed files with 26 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@@ -6,14 +6,13 @@
## ARTEMIS. In a nutshell. ## ARTEMIS. In a nutshell.
In short, ARTEMIS is a signals hunter software and a useful aid for radio listeners! The analysis of real-time spectra (from your SDR, for instance is made simple: you can take advantage using one of the largest RF signal database (with over 370 records). Compare several signals properties (such as frequency, bandwidth, modulation, etc.) and verify what you are searching for through a waterfall/audio sample. A collection of filters allows you to narrow your search, making the identification of unknown signals, odd buzzes or weird noises way easier. In short, ARTEMIS is a signals hunter software and a useful aid for radio listeners! The analysis of real-time spectra (from your SDR, for instance) is made simple: you can take advantage using one of the largest RF signal database (with over 370 records). Compare several signals properties (such as frequency, bandwidth, modulation, etc.) and verify what you are searching for through a waterfall/audio sample. A collection of filters allows you to narrow your search, making the identification of unknown signals, odd buzzes or weird noises way easier.
## Table of contents ## Table of contents
- [Installation](#installation) - [Run the software](#Run-the-software)
- [Run from binary](#Run-from-binary) - [Run from binary](#Run-from-binary)
- [Run from source code](#Run-from-source-code-OS-independent) - [Run from source code](#Run-from-source-code-OS-independent)
- [Run using deploy script](#Run-using-deploy-script)
- [Database](#database) - [Database](#database)
- [Syntax](#syntax) - [Syntax](#syntax)
- [Multiple Items fields (Location, Modulation)](#multiple-items-fields-location-modulation) - [Multiple Items fields (Location, Modulation)](#multiple-items-fields-location-modulation)
@@ -21,21 +20,22 @@ In short, ARTEMIS is a signals hunter software and a useful aid for radio listen
- [License](#license) - [License](#license)
- [Thanks](#thanks) - [Thanks](#thanks)
## Installation ## Run the software
The power of the new Artemis is the native multi-environment capability. To achieve this point, the entire code has been written in python. The procedure of Artemis 3 deployment is very similar among the different main operative systems (Windows, Linux or MacOS) but, in principle, any OS capable of running python scripts has all the necessary features to run Artemis smoothly.
## Run from binary Artemis 3 is entirely written in Python, so if you already have Python 3.7.0+ installed in your system, you can directly run the main script. Otherwise you can download a binary executable (see below).
### Run from binary
**If you don't know what you want or you are not sure where to look, this is for you.** **If you don't know what you want or you are not sure where to look, this is for you.**
Basically, this is the easiest, smooth, and clean way to run Artemis 3. Python 3.7 and the libraries are not required because they are already contained into the bundle. Basically, this is the easiest, smooth, and clean way to run Artemis 3. A Python installation is not required.
For more information, follow the main page of Artemis 3: https://aresvalley.com/artemis/ (detailed documentation at the end of the main page) For more information, follow [the main page of Artemis 3](https://aresvalley.com/artemis/) (detailed documentation at the end of the main page)
## Run from source code (OS independent) ### Run from source code
Run the software from the source code with the Python interpreter is the simplest and natural way to run Artemis 3. The main drawback: this is not the most convenient or fast way to launch the software. Requirements: Run the software from the source code with the Python interpreter is the simplest and natural way to run Artemis 3. Requirements:
- Python 3 (>3.7.0+) - Python (ver. 3.7.0+)
- Python libraries (in `requirements/requirements.txt`) - Python libraries (in `requirements/requirements.txt`)
1. Download and install Python 3 (>3.7.0+) from the official website (https://www.python.org/downloads/). Be sure to select the flag `Add Python 3.x to PATH` during the first part of the installation. 1. Download and install Python (ver. 3.7.0+) from the official [website](https://www.python.org/downloads/). Be sure to select the flag `Add Python 3.x to PATH` during the first part of the installation.
2. Install the necessary Python libraries with PIP. Open a console in Artemis/requirements folder and type: 2. Install the necessary Python libraries with PIP. Open a console in Artemis/requirements folder and type:
@@ -49,12 +49,6 @@ pip install -r requirements.txt --user
python3 artemis.py python3 artemis.py
``` ```
## Run using deploy script
This is a third option to run Artemis 3 on your pc. The method of installation is based on an automatic script that set privileges, install dependencies and create a working shortcut to your desktop/menu.
**For the sake of completeness, the documentation is available in `unused_installation_scripts`, but we strongly discourage any attempt to use it.**
## Database ## Database
The database (db.csv) is directly extracted from sigidwiki.com with a DB parser and reworked to a standard format defined as follow. Artemis DB is a human-readable csv file where the delimiter is the character `*` (Asterisk, Unicode: U+002A). The new entry (separation between signals) is the End Of Line (EOL) escape sequence `\n`. Every signal is directly connected to spectra and audio sample stored in **Spectra** and **Audio** folders, respectively. Every signal is composed of 12 columns: The database (db.csv) is directly extracted from sigidwiki.com with a DB parser and reworked to a standard format defined as follow. Artemis DB is a human-readable csv file where the delimiter is the character `*` (Asterisk, Unicode: U+002A). The new entry (separation between signals) is the End Of Line (EOL) escape sequence `\n`. Every signal is directly connected to spectra and audio sample stored in **Spectra** and **Audio** folders, respectively. Every signal is composed of 12 columns:
@@ -131,9 +125,10 @@ This program is distributed in the hope that it will be useful, but WITHOUT ANY
You should have received a copy of the GNU General Public License along with this program. If not, see: www.gnu.org/licenses You should have received a copy of the GNU General Public License along with this program. If not, see: www.gnu.org/licenses
## Thanks ## Thanks
* **Marco D.T.** - *Artemis I-II programmer, DB parsing, Website* * **Marco Dalla Tiezza** - *Artemis I-II developer, DB parsing, Website*
* **Alessandro C.** - *Artemis III lead programmer* * [**Alessandro Ceccato**](https://github.com/alessandro90 "GitHub profile") - *Artemis III lead developer*
* **Paolo R. (IZ1MLL)** - *Lead β Tester, RF specialist* * **Paolo Romani (IZ1MLL)** - *Lead β Tester, RF specialist*
* **Carl C.** - *Sigidwiki admin, β Tester, Signals expert* * **Carl Colena** - *Sigidwiki admin, β Tester, Signals expert*
* **Marco B.** - *macOS deployment, β Tester* * **Marco Bortoli** - *macOS deployment, β Tester*
* **Francesco C., Pierpaolo P., Luca XYZ, Paolo XYZ, Daniele XYZ** - *β Tester* * **Pierpaolo Pravatto** - *Wiki page, β Tester*
* **Francesco Capostagno, Luca, Pietro** - *β Tester*

13
unused_installation_scripts/README.md
View File

@@ -69,9 +69,10 @@ This program is distributed in the hope that it will be useful, but WITHOUT ANY
You should have received a copy of the GNU General Public License along with this program. If not, see: www.gnu.org/licenses You should have received a copy of the GNU General Public License along with this program. If not, see: www.gnu.org/licenses
## Thanks ## Thanks
* **Marco D.T.** - *Artemis I-II programmer, DB parsing, Website* * **Marco Dalla Tiezza** - *Artemis I-II developer, DB parsing, Website*
* **Alessandro C.** - *Artemis III lead programmer* * [**Alessandro Ceccato**](https://github.com/alessandro90 "GitHub profile") - *Artemis III lead developer*
* **Paolo R. (IZ1MLL)** - *Lead β Tester, RF specialist* * **Paolo Romani (IZ1MLL)** - *Lead β Tester, RF specialist*
* **Carl C.** - *Sigidwiki admin, β Tester, Signals expert* * **Carl Colena** - *Sigidwiki admin, β Tester, Signals expert*
* **Marco B.** - *macOS deployment, β Tester* * **Marco Bortoli** - *macOS deployment, β Tester*
* **Francesco C., Pierpaolo P., Luca XYZ, Paolo XYZ, Daniele XYZ** - *β Tester* * **Pierpaolo Pravatto** - *Wiki page, β Tester*
* **Francesco Capostagno, Luca, Pietro** - *β Tester*