Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the text in the README for the new analysis documentation #57

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 35 additions & 2 deletions ec2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ A new analysis task for insertion into the PV Validation Hub needs to contain ce
- Data files - folder containing all csv files the analysis
- Ground truth files - folder containing all results for each data file

Below is an screenshot of an example folder containing all of the files/subfolders for an analysis insertion.

![alt text](file-structure-example.png)

### config.json

Example JSON:
Expand Down Expand Up @@ -100,17 +104,46 @@ Example JSON:
Required columns:

```csv
system_id,name,azimuth,tilt,elevation,latitude,longitude,tracking,climate_type,dc_capacity
system_id,name,latitude,longitude
```

Optional columns:

```csv
azimuth,tilt,elevation,tracking,dc_capacity
```

Ideally we want to include as many optional columns as we can, although for some data sets this may not be possible as the data is unavailable.


### file_metadata.csv

Required columns:

```csv
file_id,system_id,file_name,timezone,data_sampling_frequency,issue
file_id,system_id,file_name
```

Optional columns:

```csv
timezone,data_sampling_frequency,issue,data_type
```

Optional columns may vary based on the type of problem being solved, and is subject to change as needed.

### ./file_data/ folder

This folder contains all of the individual files that we are going to feed into the runner to assess the associated algorithm. File names in this folder link directly to the file_name column in the `file_metadata.csv` file. Columns in these files can vary based on the type of inputs being assessed. A screenshot of an example file for the time shift problem is shown below.

![alt text](input-file-data.png)

### ./validation_data/ folder

This folder contains all of the files that contains the "ground-truth" results, to be assessed against the runner outputs. Files in this folder have the same naming conventions as the files in the ./file_data/ folder, so these files can be successfully linked to their input data file counterparts. Data in these files will vary based on what target variable is being assessed. A screenshot of an example output file for the time shift problem is shown below.

![alt text](output-file-data.png)

### template.py (Marimo template with cli args input)

Marimo python file will need to input data from `mo.cli_args()` method
Expand Down
Binary file added ec2/file-structure-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ec2/input-file-data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ec2/output-file-data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.