You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: samples/python-jupyter-notebook-webapi/README.md
+7-2
Original file line number
Diff line number
Diff line change
@@ -19,13 +19,18 @@ After Generating the Python client for the Carbon Aware SDK (with swagger openap
19
19
1. Update conda: `conda update conda`
20
20
2. Create the environment (Call it `sdktest`) with `conda create -n sdktest python=3.8` and you will need to select 'Y' at the prompt to proceed.
21
21
3. Activate the environment: `source activate sdktest`.
22
-
4. Install all required packages: `pip install -r requirements.txt`.
22
+
4. Install all required packages: `conda install jupyter` and `pip install -r requirements.txt`.
23
23
5. Get some space back: `conda clean -a`
24
24
6. Change directory into the generated client directory in order to install it. If moved to this directory: `cd python/`.
25
25
7. Install the carbon aware SDK `python setup.py install`
26
26
8. Change directory back to the sample: `cd ~/carbon-aware-sdk/samples/python-jupyter-notebook-webapi`.
27
27
9. Copy the `.env.template` file and rename it to `.env`: `cp .env.template .env`
28
28
10. Edit the `.env` file and fill in with the url of a deployed Carbon Aware SDK Web API or your own. By default the url is pointing at `https://localhost:5073`. Command: `echo "SDK_WEB_HOST = '<CARBON_AWARE_SDK_API_URL>'" > .env`
29
-
11. Start the notebook server: `jupyter-lab`
29
+
11. Start the notebook server: `jupyter-lab` or `python -m jupyter-lab`
30
30
12. Open the `Carbon_aware_SDK_demo.ipynb` notebook and follow the flow of it.
31
31
12. When you're done, execute `conda deactivate` to deactivate the environment and then `conda env remove -n sdktest` to remove it.
32
+
33
+
34
+
## Contents of the notebook
35
+
36
+
The notebook contains an example usage of a generated python library for the Carbon Aware SDK, and shows an *example* benefit of time shifting and location shifting. This can be a useful starting point for building a business case around doing a larger time shift or location shift.
0 commit comments