Skip to content

Commit

Permalink
Chore: Update POLISH_TEMPLATE.md
Browse files Browse the repository at this point in the history
Signed-off-by: Matthew Watkins <[email protected]>
  • Loading branch information
ModeSevenIndustrialSolutions committed Nov 23, 2023
1 parent b3eb94b commit af0a3b5
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 9 deletions.
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Bug Reporting

---

name: Bug report
about: Create a report to help us improve
labels: bug

---

**Describe the bug**
Expand Down
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Feature Requests

---

name: Feature request
about: Suggest an idea for this project
labels: enhancement

---

**Is your feature request related to a problem? Please describe.**
Expand Down
2 changes: 2 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/POLISH_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Polish Notebook(s)

---
name: Polish Notebook(s)
about: Finalize notebooks prior to publishing or promoting
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ Actions are configured to release to PyPI on pushing a tag. In order to do this:
- Update VERSION
- Create new annotated tag and push

git tag -a v1.0.0 -m "v1.0.0"
git push --follow-tags
git tag -a v1.0.0 -m "v1.0.0"
git push --follow-tags

## Forking workflow

Expand Down
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ Physrisk is also designed to be a hosted, e.g. to provide on-demand calculations

The library can be run locally, although access to the hazard indicator data is needed. The library is installed via:

pip install physrisk-lib

pip install physrisk-lib

Hazard indicator data is freely available. Members of the project are able to access OS-Climate S3 buckets. Credentials are available [here](https://console-openshift-console.apps.odh-cl1.apps.os-climate.org/k8s/ns/sandbox/secrets/physrisk-s3-keys). Information about the project is available via the [community-hub](https://github.com/os-climate/OS-Climate-Community-Hub). Non-members are able to download or copy hazard indicator data.

Expand All @@ -36,11 +35,11 @@ An inventory of the hazard data is maintained [here](https://github.com/os-clima

Access to hazard event data requires setting of environment variables specifying the S3 Bucket, for example:

OSC_S3_BUCKET=physrisk-hazard-indicators
OSC_S3_ACCESS_KEY=**********
OSC_S3_SECRET_KEY=**********
OSC_S3_BUCKET=physrisk-hazard-indicators
OSC_S3_ACCESS_KEY=**********
OSC_S3_SECRET_KEY=**********

For use in a Jupyter environment, it is recommended to put the environment variables in a credentials.env file and do, for example:

from dotenv import load_dotenv
load_dotenv(dotenv_path=dotenv_path, override=True)
from dotenv import load_dotenv
load_dotenv(dotenv_path=dotenv_path, override=True)

0 comments on commit af0a3b5

Please sign in to comment.