From 2e0d96b557323ea47fc832592485a2c473f31d9b Mon Sep 17 00:00:00 2001 From: "Sara A. Miskovich" Date: Tue, 6 Feb 2024 10:20:20 -0800 Subject: [PATCH] added info in READMEs --- sdt_dask/clients/aws/README.md | 2 +- sdt_dask/dataplugs/README.md | 10 +++++++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/sdt_dask/clients/aws/README.md b/sdt_dask/clients/aws/README.md index c279936f..a3524f78 100644 --- a/sdt_dask/clients/aws/README.md +++ b/sdt_dask/clients/aws/README.md @@ -43,7 +43,7 @@ If you have additional dependencies, install them as well (both Docker image and ## Docker Image 1. Install your python requirements and all dependencies as steps in your dockerfile. - Here's a sample dockerfile with solar-data-tools dependencies and all the packages listed above: [link](Dockerfile) + Here's a sample dockerfile with solar-data-tools dependencies and all the packages listed above: [link](Dockerfile). (To create a ```requirements.txt``` file that works with pip in Docker from a conda env, you can install pip in your conda env, then run ```pip list --format=freeze > requirements.txt```). 2. Build a docker image 1. Go to the directory where your Dockerfile is 2. ```docker build -t .``` diff --git a/sdt_dask/dataplugs/README.md b/sdt_dask/dataplugs/README.md index e4db4d8a..9f8c05fc 100644 --- a/sdt_dask/dataplugs/README.md +++ b/sdt_dask/dataplugs/README.md @@ -1,4 +1,12 @@ # Prepare your data plug Here is the basic usage of the example data plugs and instruction on how to write you own. -[TODO] \ No newline at end of file +**Note that if the data plug depends on any packages that are not in the Python standard library, they should be included in a requirements.txt file that accompanies the data plug.** + +[TODO] Fill out info about example data plugs and how users can write their own. + +[TODO] Make a standard attribute for data plugs: a tuple that has one, two or more values corresponding to the inputs that each data plug requires: +- CSV plug: list of file names +- PVDAQ plug: files IDs and associated years +- PVDB (Redshift) plug: list of site IDs and list of inverter index numbers + - needs list of non-standard libraries in requirements file (```requests``` only so far) \ No newline at end of file