Skip to content

Commit

Permalink
initial commit with probe matcher script
Browse files Browse the repository at this point in the history
  • Loading branch information
kaitlyn-sharo committed Mar 28, 2024
1 parent 54cffa1 commit ddc0e12
Show file tree
Hide file tree
Showing 116 changed files with 328,931 additions and 1 deletion.
3 changes: 3 additions & 0 deletions .env
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#### GENERAL CONFIG ####
# level of logging (1=debug, 2=info, 3=warn, 4=error)
LOG_LEVEL=2
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# virtual environment
ingest

# junk folder
__pycache__

# output folder
output

# annoying mac file
*.DS_Store
57 changes: 56 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,56 @@
# itm-ingest
# ITM Ingest Tool
Sends processed data to the database

## Getting Started

### Creating a Virtual Environment
```
python3.8 -m venv ingest
```
Note: You may have to install venv tools on your system. For linux, the command is
```
sudo apt install python3.8-venv
```

To activate the virtual environment:

**Windows:**
```
ingest\Scripts\activate
```

**MacOS/Linux:**
```
source ingest/bin/activate
```

You are now in a virtual environment where you can install the requirements and run the main script.

To deactivate the environment, run
```
deactivate
```

### Installing from Requirements
```
pip install -r requirements.txt
```

## Running the Probe Matcher
The probe matcher takes in a path leading to a directory of Unity Simulator data. For each json file found, the script attempts to find matches within the actionList for each of the adept and soartech yaml files.
d
To run the probe matcher, execute the following command:
```
python3 probe_matcher.py -i [path_to_directory]
```
Ensure that the path leads to the Unity Simulator data. The format should be: top-level -> id -> id -> json, with csvs directly under top-level. As the Unity file output organization format changes, the way of accessing this data may also change.

### Output
The probe matcher will output two json files for each input json found: one for soartech and one for adept. If SEND_TO_MONGO is true, these json files (and the raw jsons found) will be sent to the mongo database

## Data in Repository
| Directory | Explanation |
| - | - |
| `metrics-data` | Contains all of the valid simulator outputs in the same organizational structure unity outputs. |
| `adept-evals` | The yaml files for each adept evaluation scenario |
| `soartech-evals` | The yaml files for each soartech evaluation scenario |
Loading

0 comments on commit ddc0e12

Please sign in to comment.