Data

Tools

Indexes

Applications

Experiments

Open Source Science

naturf

naturf: a package for generating urban parameters for numerical weather modeling - Published in JOSS (2024)

https://github.com/immm-sfa/naturf

Science Score: 85.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • ✓
    Committers with academic emails
    4 of 8 committers (50.0%) from academic institutions
  • ✓
    Institutional organization owner
    Organization immm-sfa has institutional domain (im3.pnnl.gov)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.7%) to scientific vocabulary

Scientific Fields

Engineering Computer Science - 40% confidence
Last synced: 6 months ago · JSON representation ·

Repository

NATURF: Neighborhood Adaptive Tissues for Urban Resilience Futures

Basic Info
Statistics
  • Stars: 12
  • Watchers: 5
  • Forks: 2
  • Open Issues: 3
  • Releases: 6
Created almost 4 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

DOI PyPI version codecov build Deploy Documentation JOSS

naturf

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

Purpose

naturf was created to:

  • Calculate 132 urban parameters based on building footprints and height,
  • Compile the parameters at sub-kilometer resolutions into binary files,
  • Prepare binary files to be fed into WRF to understand the effect of building morphology on the urban microclimate.

Install

bash pip install naturf

Check out a quickstart tutorial to run naturf

Run naturf! Check out the naturf ipynb Quickstarter or the naturf Python Quickstarter.

User guide

Our user guide provides in-depth information on the key concepts of naturf with useful background information and explanation.

Contributing

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

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

Developer Setup

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

First install pre-commit.

Then install the hooks within the repo:

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

Data Products and other citations

Allen-Dumas, Melissa R., Sweet-Breu, Levi, Rexer, Emily, and Vernon, Chris. Neighborhood Adaptive Tissues for Urban Resilience Futures (NATURF) V1.0. Computer Software. https://github.com/IMMM-SFA/naturf. USDOE Office of Science (SC), Biological and Environmental Research (BER). Earth & Environmental Systems Science (EESS). 03 Jun. 2024. Web. doi:10.11578/dc.20240531.1.

Sweet-Breu, L., & Allen-Dumas, M. (2024). Urban Parameters LA County 100m (Version v1) [Data set]. MSD-LIVE Data Repository. https://doi.org/10.57931/2349436

Allen-Dumas M ; Sweet-Breu L (2024): Urban Parameters Maricopa County 100m Grid Spacing. Southwest Urban Corridor Integrated Field Laboratory (SW-IFL), ESS-DIVE repository. Dataset. ess-dive-b6200929fa5b268-20240604T184443135 accessed via https://data.ess-dive.lbl.gov/datasets/ess-dive-b6200929fa5b268-20240604T184443135 on 2024-06-04.

Sample data citation

OpenDataDC (2021) Open Data DC. URL https://opendata.dc.gov/datasets

Owner

  • Name: Integrated Multisector Multiscale Modeling
  • Login: IMMM-SFA
  • Kind: organization
  • Location: Richland, WA

Models and code from the IM3 SFA

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Allen-Dumas
    given-names: Melissa R.
    orcid: "https://orcid.org/0000-0002-3319-0846"
  - family-names: Sweet-Breu
    given-names: Levi T.
    orcid: "https://orcid.org/0000-0003-3325-8086"
  - family-names: Rexer
    given-names: Em
    orcid: "https://orcid.org/0000-0002-0327-183X"
  - family-names: Vernon
    given-names: Chris R.
    orcid: "https://orcid.org/0000-0002-3406-6214"

title: "naturf: a package for generating urban parameters for numerical weather modeling"
version: 1.0.4
doi: 10.5281/zenodo.7036191
date-released: 2024-06-03
url: "https://github.com/IMMM-SFA/naturf"

GitHub Events

Total
  • Watch event: 5
  • Delete event: 1
  • Issue comment event: 5
  • Push event: 17
  • Pull request review comment event: 6
  • Pull request review event: 4
  • Pull request event: 6
  • Create event: 4
Last Year
  • Watch event: 5
  • Delete event: 1
  • Issue comment event: 5
  • Push event: 17
  • Pull request review comment event: 6
  • Pull request review event: 4
  • Pull request event: 6
  • Create event: 4

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 437
  • Total Committers: 8
  • Avg Commits per committer: 54.625
  • Development Distribution Score (DDS): 0.574
Past Year
  • Commits: 8
  • Committers: 2
  • Avg Commits per committer: 4.0
  • Development Distribution Score (DDS): 0.125
Top Committers
Name Email Commits
levisweet l****t@v****u 186
erexer 1****r 163
Chris Vernon c****n@g****m 68
Stefan Krawczyk s****n@d****o 9
Dumas, Melissa a****r@o****v 7
kurte k****0@o****v 2
Travis Thurber t****r 1
Sweet L T l****6@0****v 1
Committer Domains (Top 20 + Academic)
ornl.gov: 2 0b-a5dc294903.ornl.gov: 1 dagworks.io: 1 vols.utk.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 56
  • Total pull requests: 52
  • Average time to close issues: about 2 months
  • Average time to close pull requests: about 18 hours
  • Total issue authors: 4
  • Total pull request authors: 5
  • Average comments per issue: 0.29
  • Average comments per pull request: 0.63
  • Merged pull requests: 51
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 8
  • Average time to close issues: N/A
  • Average time to close pull requests: 28 minutes
  • Issue authors: 0
  • Pull request authors: 3
  • Average comments per issue: 0
  • Average comments per pull request: 1.0
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • erexer (33)
  • levisweetbreu (16)
  • praneethd7 (4)
  • caimeng2 (3)
Pull Request Authors
  • erexer (44)
  • levisweetbreu (15)
  • skrawcz (5)
  • crvernon (4)
  • thurber (1)
Top Labels
Issue Labels
documentation (4) enhancement (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 20 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 5
  • Total maintainers: 1
pypi.org: naturf

The Neighborhood Adaptive Tissues for Urban Resilience Futures tool (NATURF) is a Python workflow that generates data readable by the Weather Research and Forecasting (WRF) model. The NATURF Python modules use shapefiles containing building footprint and height data as input to calculate 132 building parameters at any resolution and converts the parameters into a binary file format.

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 20 Last month
Rankings
Dependent packages count: 10.0%
Average: 37.9%
Dependent repos count: 65.8%
Maintainers (1)
erexer
Last synced: 6 months ago