Skip to content

Commit

Permalink
edit formatting, re-add developer setup
Browse files Browse the repository at this point in the history
  • Loading branch information
levisweetbreu committed Jan 31, 2024
1 parent ff18afa commit 1414ac3
Showing 1 changed file with 29 additions and 4 deletions.
33 changes: 29 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
[![codecov](https://codecov.io/gh/IMMM-SFA/naturf/graph/badge.svg?token=SoIfjdS6BL)](https://codecov.io/gh/IMMM-SFA/naturf)
[![build](https://github.com/IMMM-SFA/naturf/actions/workflows/build.yml/badge.svg)](https://github.com/IMMM-SFA/naturf/actions/workflows/build.yml)

## naturf
# naturf

#### `naturf` is an open-source geospatial Python package for calculating urban building parameters to be compiled and input to the Weather Research and Forecasting model (WRF).
#### `naturf` (Neighborhood Adaptive Tissues for Urban Resilience Futures) is an open-source geospatial Python package for calculating urban building parameters to be compiled and input to the Weather Research and Forecasting model (WRF).

### Purpose
`naturf` was created to:
Expand Down Expand Up @@ -38,9 +38,34 @@ Whether you find a typo in the documentation, find a bug, or want to develop fun

The reference guide contains a detailed description of the `naturf` API. The reference describes how the methods work and which parameters can be used. It assumes that you have an understanding of the key concepts. See [API Reference](https://immm-sfa.github.io/naturf/modules.html)

### Pre-commit
### Developer Setup

`naturf` uses `pre-commit`. Instructions for installation can be found [here](https://pre-commit.com/)
To get started on development, install the pre-commit hooks to format code.

For `homebrew`:

```bash
$ brew install pre-commit
```

For `pip`:

```bash
$ pip install pre-commit
```

For `conda`:

```bash
$ conda install -c conda-forge pre-commit
```

Then install the hooks within the repo:

```bash
$ cd /PATH/TO/NATURF
$ pre-commit install
```

### Code citation

Expand Down

0 comments on commit 1414ac3

Please sign in to comment.