Skip to content

Commit

Permalink
added info in READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
pluflou committed Feb 6, 2024
1 parent fe64074 commit 2e0d96b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
2 changes: 1 addition & 1 deletion sdt_dask/clients/aws/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <YOUR_IMAGE_NAME> .```
Expand Down
10 changes: 9 additions & 1 deletion sdt_dask/dataplugs/README.md
Original file line number Diff line number Diff line change
@@ -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]
**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)

0 comments on commit 2e0d96b

Please sign in to comment.