| Name | physrisk JSON |
| Version |
0.20.0
JSON |
| download |
| home_page | |
| Summary | Physical climate risk calculation engine. |
| upload_time | 2023-11-27 10:30:20 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | <3.11,>=3.9 |
| license | Apache-2.0 |
| keywords |
climate
physical
risk
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Physrisk
Physical climate risk calculation engine.
<img src="docs/images/OS-Climate-Logo.png" alt="drawing" width="150"/>
## About physrisk
An [OS-Climate](https://os-climate.org) project, physrisk is a library for assessing the physical effects of climate change and thereby the potential benefit of measures to improve resilience.
An introduction and methodology is available [here](https://github.com/os-climate/physrisk/blob/main/methodology/PhysicalRiskMethodology.pdf).
Physrisk is primarily designed to run 'bottom-up' calculations that model the impact of climate hazards on large numbers of individual assets (including natural) and operations. These calculations can be used to assess financial risks or socio-economic impacts. To do this physrisk collects:
- hazard indicators and
- models of vulnerability of assets/operations to hazards.
Hazard indicators are on-boarded from public resources or inferred from climate projections, e.g. from CMIP or CORDEX data sets. Indicators are created from code in the
[hazard repo](https://github.com/os-climate/hazard) to make calculations as transparent as possible.
Physrisk is also designed to be a hosted, e.g. to provide on-demand calculations. [physrisk-api](https://github.com/os-climate/physrisk-api) and [physrisk-ui](https://github.com/os-climate/physrisk-ui) provide an example API and user interface. A [development version of the UI](https://physrisk-ui-sandbox.apps.odh-cl1.apps.os-climate.org) is hosted by OS-Climate.
## Using the library
The library can be run locally, although access to the hazard indicator data is needed. The library is installed via:
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.
Hazard indicator data can be downloaded or copied from the 'os-climate-public-data' bucket. A list of the keys to copy is available from
<https://os-climate-public-data.s3.amazonaws.com/hazard/keys.txt>
An inventory of the hazard data is maintained [here](https://github.com/os-climate/hazard/blob/main/src/inventories/hazard/inventory.json) (this is used by the physrisk library itself). The [UI hazard viewer](https://physrisk-ui-sandbox.apps.odh-cl1.apps.os-climate.org) is a convenient way to browse data sets.
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=**********
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)
Raw data
{
"_id": null,
"home_page": "",
"name": "physrisk",
"maintainer": "",
"docs_url": null,
"requires_python": "<3.11,>=3.9",
"maintainer_email": "",
"keywords": "Climate Physical Risk",
"author": "",
"author_email": "Joe Moorhouse <72577720+MichaelTiemannOSC@users.noreply.github.com>, Joseph Moorhouse <72577720+MichaelTiemannOSC@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/03/f1/e2309f7da275d60961d11e0a9d8bf8cf5e358b4fec811555dd683f0b962b/physrisk-0.20.0.tar.gz",
"platform": null,
"description": "# Physrisk\n\nPhysical climate risk calculation engine.\n\n<img src=\"docs/images/OS-Climate-Logo.png\" alt=\"drawing\" width=\"150\"/>\n\n## About physrisk\n\nAn [OS-Climate](https://os-climate.org) project, physrisk is a library for assessing the physical effects of climate change and thereby the potential benefit of measures to improve resilience.\n\nAn introduction and methodology is available [here](https://github.com/os-climate/physrisk/blob/main/methodology/PhysicalRiskMethodology.pdf).\n\nPhysrisk is primarily designed to run 'bottom-up' calculations that model the impact of climate hazards on large numbers of individual assets (including natural) and operations. These calculations can be used to assess financial risks or socio-economic impacts. To do this physrisk collects:\n\n- hazard indicators and\n- models of vulnerability of assets/operations to hazards.\n\nHazard indicators are on-boarded from public resources or inferred from climate projections, e.g. from CMIP or CORDEX data sets. Indicators are created from code in the\n[hazard repo](https://github.com/os-climate/hazard) to make calculations as transparent as possible.\n\nPhysrisk is also designed to be a hosted, e.g. to provide on-demand calculations. [physrisk-api](https://github.com/os-climate/physrisk-api) and [physrisk-ui](https://github.com/os-climate/physrisk-ui) provide an example API and user interface. A [development version of the UI](https://physrisk-ui-sandbox.apps.odh-cl1.apps.os-climate.org) is hosted by OS-Climate.\n\n## Using the library\n\nThe library can be run locally, although access to the hazard indicator data is needed. The library is installed via:\n\n pip install physrisk-lib\n\nHazard 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.\n\nHazard indicator data can be downloaded or copied from the 'os-climate-public-data' bucket. A list of the keys to copy is available from\n<https://os-climate-public-data.s3.amazonaws.com/hazard/keys.txt>\n\nAn inventory of the hazard data is maintained [here](https://github.com/os-climate/hazard/blob/main/src/inventories/hazard/inventory.json) (this is used by the physrisk library itself). The [UI hazard viewer](https://physrisk-ui-sandbox.apps.odh-cl1.apps.os-climate.org) is a convenient way to browse data sets.\n\nAccess to hazard event data requires setting of environment variables specifying the S3 Bucket, for example:\n\n OSC_S3_BUCKET=physrisk-hazard-indicators\n OSC_S3_ACCESS_KEY=**********\n OSC_S3_SECRET_KEY=**********\n\nFor use in a Jupyter environment, it is recommended to put the environment variables in a credentials.env file and do, for example:\n\n from dotenv import load_dotenv\n load_dotenv(dotenv_path=dotenv_path, override=True)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Physical climate risk calculation engine.",
"version": "0.20.0",
"project_urls": {
"Bug tracker": "https://github.com/os-climate/physrisk/issues",
"Documentation": "https://github.com/os-climate/physrisk/tree/main/docs",
"Downloads": "https://github.com/os-climate/physrisk/releases",
"Homepage": "https://github.com/is-climate/physrisk",
"Repository": "https://github.com/os-climate/physrisk",
"Source code": "https://github.com/os-climate/physrisk"
},
"split_keywords": [
"climate",
"physical",
"risk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c03dac0a56ef0a9aab9e9ec400a06681a2e9f280ef5abb9aba20a7b884f4f1b4",
"md5": "757de2e08e6ba785141a156f6456f580",
"sha256": "ea44168ebb653dad1c0fcc4c7e7f49e16a3610b06af0d822abeed0480fbe8fd2"
},
"downloads": -1,
"filename": "physrisk-0.20.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "757de2e08e6ba785141a156f6456f580",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.11,>=3.9",
"size": 476971,
"upload_time": "2023-11-27T10:30:17",
"upload_time_iso_8601": "2023-11-27T10:30:17.913922Z",
"url": "https://files.pythonhosted.org/packages/c0/3d/ac0a56ef0a9aab9e9ec400a06681a2e9f280ef5abb9aba20a7b884f4f1b4/physrisk-0.20.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "03f1e2309f7da275d60961d11e0a9d8bf8cf5e358b4fec811555dd683f0b962b",
"md5": "734c4388847954dc520fce13c2a9de29",
"sha256": "88f2d46acc8ee3f11dbfa6de215269138b508a4ec47218e0119c1ae93230dfd7"
},
"downloads": -1,
"filename": "physrisk-0.20.0.tar.gz",
"has_sig": false,
"md5_digest": "734c4388847954dc520fce13c2a9de29",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.11,>=3.9",
"size": 661231,
"upload_time": "2023-11-27T10:30:20",
"upload_time_iso_8601": "2023-11-27T10:30:20.502278Z",
"url": "https://files.pythonhosted.org/packages/03/f1/e2309f7da275d60961d11e0a9d8bf8cf5e358b4fec811555dd683f0b962b/physrisk-0.20.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-27 10:30:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "os-climate",
"github_project": "physrisk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "physrisk"
}
