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: README.md
+1-2Lines changed: 1 addition & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,9 @@
1
1
# codegreen python client :seedling:
2
-
This repository contains the source code for the codegreen python client. For more information on the usage and background of this tool please go to our documentation on Readthedocs and the website [https://codegreen.world](https://codegreen.world). Please note that in order to use this webservice, you will need to generate an API key on the website.
2
+
This repository contains the source code for the codegreen python client. For more information on the usage and background of this tool please go to our documentation on Readthedocs and the website [https://codegreen.world](https://codegreen.world). Please note that in order to use this web service, you will need to generate an API key on the website.
3
3
4
4
> **Warning**
5
5
> We are extremely happy that you consider using our tool. We are still actively developing the functionalities. If there are problems, please file and issue or contact us directly. Stay green! :seedling:
6
6
7
-
##
8
7
## Functionalities
9
8
This package is designed to make timeshifting computations easy. They main functionalities are
10
9
1. Providing python decorators to timeshift, monitor and report the carbon footprint of computation. The functionalities can of course also be used indvidually.
:param percent_renewable: Required percentage of renewable energy available in the grid at the time of computation, defaults to 40
30
-
:type percent_renewable: int, optional
31
-
:param hard_finish_time: deadline for when the computation needs to be finished, defaults to datetime.utcnow().replace(hour=18, minute=0, second=0).timestamp()
23
+
:param hard_finish_time: deadline for when the computation needs to be finished, defaults to 24 hours from the current time
:param area_code: list of area codes with a two letter country code and an optional postal code separated by a dash. Postal codes can be given as 1-5 digit areas. ['CC-PPPPP', 'CC', 'CC-P'], defaults to ['DE']
34
-
:type area_code: list[str], optional
35
25
:param log_request: allow logging the request server side, this is required to compute the carbon offset, defaults to True
36
26
:type log_request: bool, optional
37
27
:param process_id: An string to identify the experiment, defaults to None
0 commit comments