Skip to content

Update README with technical basics #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brews merged 3 commits into from
Sep 22, 2022
Merged

Update README with technical basics #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
68e6fc6
Update README with technical basics
brews Sep 22, 2022
c10d9e8
Update changelog to note changes
brews Sep 22, 2022
7216498
Remove black badge to keep it simple for now
brews Sep 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Changed
- Updated README with additional technical details. ([PR #49](https://github.com/ClimateImpactLab/dscim/pull/49), [@brews](https://github.com/brews))

## [0.2.1] - 2022-09-22
### Fixed
Expand Down
41 changes: 39 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

# DSCIM: The Data-driven Spatial Climate Impact Model

This Python library enables the calculation of sector-specific partial social cost of greenhouse gases (SC-GHG) and SCGHGs that are combined across sectors using a variety of valuation methods and assumptions. The main purpose of this
Expand All @@ -8,6 +6,45 @@ using different options ("menu options") that encompass different decisions, suc
discount levels, discount strategies, and different considerations related to
economic and climate uncertainty.

## Installation

Install with `pip` using:
```shell
pip install dscim
```

Install the unreleased bleeding-edge version of the package with:
```shell
pip install git+https://github.com/climateimpactlab/dscim
```

### Dependencies

`dscim` requires Python > 3.8. Additional compiled packages are required so we recommend installing `dscim` into a `conda` environment along with its dependencies.

- numpy
- pandas
- xarray
- matplotlib
- dask
- distributed
- requests
- statsmodels
- click
- zarr
- dask-jobqueue
- seaborn
- geopandas
- netcdf4
- h5netcdf
- impactlab-tools
- p_tqdm

## Support
Source code is available online at https://github.com/climateimpactlab/dscim. Please file bugs in the [bug tracker](https://github.com/climateimpactlab/dscim/issues).

This software is Open Source and available under the Apache License, Version 2.0.

## Structure and logic

The library is split into several components that implement the hierarchy
Expand Down