Skip to content

Commit

Permalink
Quickstarter/update quickstarter (#153)
Browse files Browse the repository at this point in the history
* update quickstarter

* Save new PDF of paper

* update readme

* add codecov badge

* Save new PDF of paper

* add build badge

* edit formatting, re-add developer setup

* re-add link to pre-commit install

* fix license

* add codecov badge

* remove mac-specific pre-commit install instructions

* only build paper on push to main

* only build paper on push to main

* remove measurements from make_geocube, deal with depreciation warning (#149)

* remove measurements from make_geocube, deal with depreciation warning

* Save new PDF of paper

* Save new PDF of paper

* remove comment

* Save new PDF of paper

---------

Co-authored-by: erexer <erexer@users.noreply.github.com>

* only build paper if files in the paper dir are changed

* delete CHANGELOG.md

* fix formatting

* Save new PDF of paper

* Save new PDF of paper

* add importlib, more documentation

---------

Co-authored-by: levisweet <lsweet@vols.utk.edu>
Co-authored-by: levisweetbreu <levisweetbreu@users.noreply.github.com>
Co-authored-by: Levi Sweet-Breu <levisweet98@gmail.com>
Co-authored-by: erexer <erexer@users.noreply.github.com>
  • Loading branch information
5 people authored Feb 1, 2024
1 parent 129be48 commit f8487b8
Show file tree
Hide file tree
Showing 3 changed files with 1,591 additions and 1,052 deletions.
48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@
[![build](https://github.com/IMMM-SFA/naturf/actions/workflows/build.yml/badge.svg)](https://github.com/IMMM-SFA/naturf/actions/workflows/build.yml)

# naturf
<<<<<<< HEAD
<<<<<<< HEAD
=======
>>>>>>> 3bda76b (add codecov badge)
=======
>>>>>>> 891f9cf (fix formatting)
=======
>>>>>>> main
#### `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).

Expand All @@ -14,7 +22,9 @@
- Prepare binary files to be fed into WRF to understand the effect of building morphology on the urban microclimate.

### Install `naturf`
<<<<<<< HEAD

<<<<<<< HEAD
```bash
pip install naturf
```
Expand Down Expand Up @@ -42,9 +52,47 @@ The reference guide contains a detailed description of the `naturf` API. The ref

To get started on development, install the pre-commit hooks to format code.

<<<<<<< HEAD
=======
=======

```bash
pip install naturf
```
### Check out a quickstart tutorial to run `naturf`

Run `naturf` using the quickstart tutorial: [`naturf` Quickstarter](https://immm-sfa.github.io/naturf/quickstarter.html)

### Getting started

New to `naturf`? Get familiar with what `naturf` is all about in our [Getting Started](https://immm-sfa.github.io/naturf/getting_started.html)

### User guide

Our user guide provides in-depth information on the key concepts of `naturf` with useful background information and explanation. See our [User Guide](https://immm-sfa.github.io/naturf/user_guide.html)

### Contributing to `naturf`

Whether you find a typo in the documentation, find a bug, or want to develop functionality that you think will make `naturf` more robust, you are welcome to contribute! See our [Contribution Guidelines](https://immm-sfa.github.io/naturf/contributing.html)

### API reference

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)

### Developer Setup

To get started on development, install the pre-commit hooks to format code.

>>>>>>> main
First [install `pre-commit`](https://pre-commit.com/).

Then install the hooks within the repo:
>>>>>>> 77584d7 (remove mac-specific pre-commit install instructions)
=======
First [install `pre-commit`](https://pre-commit.com/).

Then install the hooks within the repo:
>>>>>>> 891f9cf (fix formatting)
```bash
$ cd /PATH/TO/NATURF
$ pre-commit install
Expand Down
Loading

0 comments on commit f8487b8

Please sign in to comment.