Merge pull request #2 from Syler1984/main

Базовая интеграция моделей #1

.gitignore

@@ -1,3 +1,8 @@
+# Project-specific
+.idea/
+data/
+*.iml
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

README.md

@@ -1,2 +1,50 @@
 # seismo-ml-models-integration
 seisan/earthworm integration scripts to process seismology data using machine learning models
+
+## Usage:
+```archive_scan.py [-h] [--config CONFIG] [options]```
+<br><br><br>
+**Optional arguments:**
+<br><br>
+```-h, --help``` show this help message and exit
+<br><br>
+```--config PATH``` path to the config file, default: "config.ini"
+<br><br>
+```--verbose VERBOSE``` 0 - non verbose, 1 - verbose
+<br><br>
+```--frequency FREQUENCY``` base stream frequency, default: 100 (Hz)
+<br><br>
+```--output_file OUTPUT_FILE_NAME``` output text file name, default: "out.txt"
+<br><br>
+```--multplt_path MULTPLT_PATH``` path to MULTPLT.DEF file
+<br><br>
+```--seisan_path SEISAN_PATH``` path to SEISAN.DEF
+<br><br>
+```--model_path MODEL_PATH```path to model file, might be empty with in-code initialized models
+<br><br>
+```--weights_path WEIGHTS_PATH``` path to model weights file
+<br><br>
+```--start_date START_DATE``` start date in ISO 8601 format:
+<br>
+&nbsp;&nbsp;&nbsp;&nbsp;```{year}-{month}-{day}T{hour}:{minute}:{second}.{microsecond}```
+<br>&nbsp;&nbsp;&nbsp;&nbsp;or<br>
+&nbsp;&nbsp;&nbsp;&nbsp;```{year}-{month}-{day}T{hour}:{minute}:{second}```
+<br>&nbsp;&nbsp;&nbsp;&nbsp;or<br>
+&nbsp;&nbsp;&nbsp;&nbsp;```{year}-{month}-{day}```
+<br>
+&nbsp;&nbsp;&nbsp;&nbsp;default: yesterday midnight
+<br><br>
+```--end_date END_DATE```   end date in ISO 8601 format
+<br><br>
+```--threshold THRESHOLD``` model prediction threshold
+
+
+## Deployment:
+1. ```git clone https://github.com/Syler1984/seismo-ml-models-integration```
+2. ```virtualenv seismo-venv``` - better do in home dir
+3. ```source seismo-venv/bin/activate```
+4. ```pip install -r requirements.txt```
+5. In *test/config.ini* specify MULTPLT.DEF path
+6. ```python archive_scan.py --config test/config.ini```
+7. Read results in *out.txt*
+8. ```python archive_scan -h``` for more info