Merge pull request #1 from silvxlabs/initial-release

Add code for initial release

Author: amarcozzi

.flake8

@@ -0,0 +1,8 @@
+[flake8]
+ignore =
+    # E501: line too long (we rely on black for this)
+    E501,
+    # Whitespace before ':'. flake8 is wrong when inside slice expressions.
+    E203,
+    # Line break before binary operator. flake8 is wrong and goes against PEP8.
+    W503,

.github/workflows/pre-commit.yaml

@@ -0,0 +1,16 @@
+name: Linting and Formatting
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  pre-commit:
+    name: Run pre-commit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          cache: pip
+      - uses: pre-commit/[email protected]

.github/workflows/release.yml

@@ -0,0 +1,108 @@
+name: Release Workflow
+
+on:
+  release:
+    types: [ published ]
+
+permissions:
+  contents: read
+
+jobs:
+  upload-to-test-pypi:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+          cache: pip
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel twine
+      - name: Build package
+        run: |
+          python setup.py sdist bdist_wheel
+      - name: Upload to Test PyPi
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }}
+        run: |
+          twine upload --repository testpypi dist/*
+
+  test-on-test-pypi:
+    needs: upload-to-test-pypi
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+          cache: pip
+      - name: Install package from Test PyPi
+        run: |
+          python -m pip install --upgrade pip
+          pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple nsvb
+      - name: Install test dependencies
+        run: |
+          pip install -r pytest
+      - name: Run pytest
+        env:
+          TEST_ENV: test_pypi
+        run: |
+          pytest
+
+  upload-to-pypi:
+    needs: test-on-test-pypi
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+          cache: pip
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel twine
+      - name: Build and publish
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          python setup.py sdist bdist_wheel
+          twine upload dist/*
+
+  test-on-pypi:
+    needs: upload-to-pypi
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+          cache: pip
+      - name: Install package from PyPi
+        run: |
+          python -m pip install --upgrade pip
+          pip install nsvb
+      - name: Install test dependencies
+        run: |
+          pip install -r pytest
+      - name: Run pytest
+        env:
+          TEST_ENV: pypi
+        run: |
+          pytest

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: requirements-txt-fixer
+
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 24.4.2
+    hooks:
+      - id: black
+      - id: black-jupyter
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.0.0
+    hooks:
+      - id: flake8

README.md

@@ -1,2 +1,15 @@
 # nsvb
 National Scale Volume and Biomass Estimators
+
+## Introduction
+
+Welcome to the NSVB library. NSVB provides a faithful implementation of the National Scale Volume and Biomass Estimators
+published by the Forest Service.
+
+## Installation
+
+nsvb is available on PyPI and can be installed using pip:
+
+```bash
+pip install nsvb
+```

nsvb/__init__.py

@@ -0,0 +1,11 @@
+Decay code,S/H,C fraction
+1,Hardwood,47
+2,Hardwood,47.3
+3,Hardwood,48.1
+4,Hardwood,48
+5,Hardwood,47.2
+1,Softwood,50.1
+2,Softwood,50.4
+3,Softwood,50.6
+4,Softwood,52
+5,Softwood,52.7

nsvb/data/REF_SPECIES.csv

@@ -0,0 +1,88 @@
+Division,HWD Y/N,Mean CR,Nobs
+132,N,43.9,"5,367"
+132,Y,41.6,"1,562"
+133,N,49.6,"4,285"
+133,Y,41.5,"1,411"
+211,N,42.6,"52,714"
+211,Y,39.2,"83,502"
+212,N,48,"156,144"
+212,Y,38.6,"228,860"
+221,N,42.2,"21,434"
+221,Y,38.5,"122,979"
+222,N,44.5,"13,614"
+222,Y,38.8,"81,313"
+223,N,42.8,"22,202"
+223,Y,38.5,"125,995"
+231,N,34.8,"174,639"
+231,Y,37.4,"234,992"
+232,N,33.1,"216,742"
+232,Y,35.8,"211,115"
+234,N,40.6,"6,069"
+234,Y,38.9,"25,984"
+242,N,48.2,"10,902"
+242,Y,35.6,"4,083"
+251,N,62.1,"2,142"
+251,Y,38.5,"34,100"
+255,N,43.1,"3,679"
+255,Y,36.6,"20,560"
+261,N,38.9,"1,499"
+261,Y,40.2,"2,480"
+262,N,28.8,11
+262,Y,40,206
+263,N,40.3,"10,068"
+263,Y,38.1,"8,704"
+313,N,65.7,"44,620"
+313,Y,46.9,"9,077"
+315,N,74.2,"2,335"
+315,Y,43.6,748
+321,N,63.1,"1,412"
+321,Y,63.8,"4,460"
+322,N,64.8,"4,646"
+322,Y,56.5,641
+331,N,56.3,"16,593"
+331,Y,41.2,"3,095"
+332,N,56.4,"2,083"
+332,Y,38.9,"5,611"
+341,N,68.5,"30,965"
+341,Y,39.9,"6,351"
+342,N,65.6,"11,752"
+342,Y,40.2,"1,908"
+411,N,29.5,"2,295"
+411,Y,28.1,"1,685"
+Islan,Y,28.7,"15,796"
+M132,N,45.9,"7,650"
+M132,Y,42.4,"2,336"
+M133,N,55.8,"1,529"
+M133,Y,44.9,331
+M134,N,58.7,202
+M134,Y,52.4,18
+M211,N,41.2,"65,999"
+M211,Y,39,"80,199"
+M221,N,42.2,"22,131"
+M221,Y,37.6,"141,153"
+M223,N,44.3,"2,347"
+M223,Y,40.3,"11,917"
+M231,N,36.4,"13,990"
+M231,Y,41.4,"15,235"
+M241,N,42.7,"47,844"
+M241,Y,44,"1,879"
+M242,N,50.4,"265,277"
+M242,Y,37.8,"20,220"
+M261,N,48.6,"103,581"
+M261,Y,40.7,"41,928"
+M262,N,61.7,"1,372"
+M262,Y,41.1,"2,735"
+M313,N,56.7,"35,229"
+M313,Y,53.3,"7,155"
+M331,N,56.1,"127,949"
+M331,Y,37.2,"34,084"
+M332,N,53.6,"135,411"
+M332,Y,43.5,"1,596"
+M333,N,48.8,"103,777"
+M333,Y,38.9,"1,994"
+M334,N,49.8,"8,682"
+M334,Y,47.9,"1,310"
+M341,N,66.6,"37,068"
+M341,Y,40.9,"11,353"
+UNDEFINED,N,46.8,"1,806,092"
+UNDEFINED,Y,38,"1,614,286"