Hide specs #17
Merged
Hide specs #17
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
danyoungday
commented
Oct 21, 2024
| En-ROADS is a climate change simulator developed by Climate Interactive. We have created a wrapper around the SDK to make it simple to use in a Python application which can be found in `enroadspy`. See `enroads_runner.py` for the main class that runs the SDK. The SDK is not included in this repository and must be requested from [Climate Interactive](https://www.climateinteractive.org/). | ||
|
|
||
| The input data format is a crazy long JSON object which I copied out of the source code, pasted into `inputSpecs.py`, and parsed into `inputSpecs.jsonl`. This format is used by the rest of the repository. | ||
| En-ROADS is a climate change simulator developed by [Climate Interactive](https://www.climateinteractive.org/). We have created a wrapper around the SDK to make it simple to use in a Python application which can be found in `enroadspy`. See `enroads_runner.py` for the main class that runs the SDK. The SDK is not included in this repository and access to it is very limited. If you would like to use this code, please contact Project Resilience at [[email protected]](mailto:[email protected]). |
There was a problem hiding this comment.
I listed myself as the point of contact, can change this later to a Project Resilience email
There was a problem hiding this comment.
Yes, you're the point of contact.
Might receive some spam though.
danyoungday
commented
Oct 21, 2024
|
|
||
| ### Installation | ||
| Run `pip install -r requirements.txt` to install the required packages. Then run `python -m enroadspy.download_sdk` to download the SDK. In order to download the SDK environment variables must be set which can be requested online from Climate Interactive. |
There was a problem hiding this comment.
Removed another reference to Climate Interactive
danyoungday
commented
Oct 21, 2024
| return pd.read_json(Path("enroadspy/inputSpecs.jsonl"), lines=True, precise_float=True) | ||
| source_code = "" | ||
| with open("enroadspy/en-roads-sdk-v24.6.0-beta1/packages/en-roads-core/dist/index.js", "r", encoding="utf-8") as f: | ||
| source_code = f.read() |
There was a problem hiding this comment.
Now instead of hard-coding this JSON object we go and find it in plaintext from the source code. Eventually we need to un hard-code the version number for the SDK
danyoungday
commented
Oct 21, 2024
| @@ -28,7 +28,7 @@ def main(): | |||
| "Please set the ENROADS_URL environment variable." | |||
| assert username is not None and password is not None, \ | |||
| "Please set the ENROADS_ID and ENROADS_PASSWORD environment variables. \ | |||
| To get access to them go to https://en-roads.climateinteractive.org/ and sign up." | |||
| To request access please refer to the README." | |||
There was a problem hiding this comment.
Removed reference to Climate Interactive
danyoungday
commented
Oct 21, 2024
There was a problem hiding this comment.
Deleted this file because we grab it from the SDK now
ofrancon
approved these changes
Oct 28, 2024
| En-ROADS is a climate change simulator developed by Climate Interactive. We have created a wrapper around the SDK to make it simple to use in a Python application which can be found in `enroadspy`. See `enroads_runner.py` for the main class that runs the SDK. The SDK is not included in this repository and must be requested from [Climate Interactive](https://www.climateinteractive.org/). | ||
|
|
||
| The input data format is a crazy long JSON object which I copied out of the source code, pasted into `inputSpecs.py`, and parsed into `inputSpecs.jsonl`. This format is used by the rest of the repository. | ||
| En-ROADS is a climate change simulator developed by [Climate Interactive](https://www.climateinteractive.org/). We have created a wrapper around the SDK to make it simple to use in a Python application which can be found in `enroadspy`. See `enroads_runner.py` for the main class that runs the SDK. The SDK is not included in this repository and access to it is very limited. If you would like to use this code, please contact Project Resilience at [[email protected]](mailto:[email protected]). |
There was a problem hiding this comment.
Yes, you're the point of contact.
Might receive some spam though.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hide input specs by retrieving the string of the hard-coded variable within the source code rather than copy/pasting it out manually.
Miscellaneous fixes throughout the repo dealing with this change which are very minor.
Small updates to the README so that we are the first point of contact for anyone wanting access to the project rather than ClimateInteractive.