dwind 0.3__tar.gz

dwind-0.3/.github/workflows/pre-commit.yml

@@ -0,0 +1,18 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main, dev]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+    - name: Run pre-commit
+      uses: pre-commit/action@v3.0.1

dwind-0.3/.github/workflows/python-publish-test.yml

@@ -0,0 +1,41 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Deploy to Test PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  release-test-pypi:
+    # Upload to Test PyPI on every pushed tag.
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+    runs-on: ubuntu-latest
+    environment:
+      name: release-pypi
+      url: https://test.pypi.org/p/dwind
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Build package
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools build wheel twine
+          python -m build
+          twine check --strict dist/*
+
+      - name: Publish package to Test PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: True
+          repository-url: https://test.pypi.org/legacy/

dwind-0.3/.github/workflows/python-publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Deploy to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  release-pypi:
+    # Upload to PyPI on every published release
+    if: github.event.action == 'published'
+    environment:
+      name: release-pypi
+      url: https://pypi.org/p/dwind
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Build package
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools build wheel twine
+          python -m build
+          twine check --strict dist/*
+
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: True

dwind-0.3/.gitignore

@@ -0,0 +1,131 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Python template
+# Byte-compiled / optimized / DLL files
+*__pycache__/*
+*.py[cod]
+*$py.class
+*.pyc
+
+log/
+# needed for h2 test inputs: tests/analysis/results/
+*_disp.txt
+
+.idea/*
+.idea/workspace.xml
+.vscode/
+
+.vscode/*
+
+# Distribution / packaging
+.Python
+env*/*
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# dotenv
+.env
+.envrc
+
+# virtualenv
+.venv/
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject
+
+# Resource data
+#resource_files/solar/*.csv
+#resource_files/wind/*.srw
+
+# Images, datafiles
+*.png
+*.xlsx
+
+*.pkl
+.DS_Store
+*.val
+*.db
+*.db-shm
+*.gz
+*.db-wal
+
+# credentials
+notebooks/.mapboxtoken
+
+# visual studio folder
+.vs/
+
+# ipynb checkpoints
+*/.ipynb_checkpoints
+
+# data
+data/urdb_tariffs/*.json
+data/cambium_csvs/*.csv
+data/geography/block_groups/*

dwind-0.3/.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+default_language_version:
+    python: python3
+repos:
+- repo: https://github.com/pycqa/isort
+  rev: 5.12.0
+  hooks:
+  - id: isort
+    name: isort
+    stages: [pre-commit]
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.5.0
+  hooks:
+  - id: trailing-whitespace
+  - id: end-of-file-fixer
+  - id: check-executables-have-shebangs
+  - id: check-json
+  - id: check-yaml
+    args: [--unsafe]  # allow Python constructors
+  - id: check-merge-conflict
+  - id: check-symlinks
+  - id: mixed-line-ending
+  - id: pretty-format-json
+    args: [--autofix]
+
+- repo: https://github.com/charliermarsh/ruff-pre-commit
+  rev: v0.8.1
+  hooks:
+    - id: ruff-format
+      types_or: [ python, pyi, jupyter ]
+    - id: ruff
+      types_or: [ python, pyi, jupyter ]
+      args: [ --fix, --unsafe-fixes]

dwind-0.3/LICENSE.txt

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2019, Alliance for Sustainable Energy, LLC
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

dwind-0.3/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: dwind
+Version: 0.3
+Summary: Distributed Wind Generation Model
+Author-email: Jane Lockshin <jane.lockshin@nrel.gov>, Paritosh Das <paritosh.das@nrel.gov>, Rob Hammond <rob.hammond@nrel.gov>
+Project-URL: source, https://github.com/NREL/dwind
+Project-URL: issues, https://github.com/NREL/dwind/issues
+Keywords: python3,wind-energy,distributed-wind,energy-production
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: nrel-rex
+Requires-Dist: numpy
+Requires-Dist: pandas>=2
+Requires-Dist: sqlalchemy
+Requires-Dist: psycopg2
+Requires-Dist: scipy
+Requires-Dist: matplotlib
+Requires-Dist: seaborn
+Requires-Dist: pyarrow==17
+Requires-Dist: fastparquet
+Requires-Dist: h5pyd
+Requires-Dist: typer
+Requires-Dist: tomli>=1.1.0; python_version < "3.11"
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Dynamic: license-file
+
+# Distributed Wind Generation Model (dWind)
+
+Please note that at this time the model can only be run on NREL's Kestrel HPC system. Though a
+savvy user could recreate our data in their own computing environment and update the
+internal pointers in the example configuration at `examples/larimer_county_btm_baseline_2025.toml`
+and `examples/model_config.toml`.
+
+## Installing dwind
+
+1. Install Anaconda or Miniconda (recommended) if not already installed.
+2. Clone the repository
+
+   ```bash
+   git clone https://github.com/NREL/dwind.git
+   ```
+
+3. Navigate to the dwind repository.
+
+   ```bash
+   cd /path/to/dwind
+   ```
+
+4. Create your dwind environment using our recommended settings and all required dependencies.
+
+    ```bash
+    conda env create -f environment.yml
+    ```
+
+## Running
+
+### Configuring
+
+`dWind` relies on 2 configuration files: 1) a system-wise setting that can be shared among a team,
+and 2) a run-specific configuration file. Both will be described below.
+
+#### Primary model configuration
+
+The primary model configuration should look exactly like (or be compatible with)
+`examples/model_config.toml` to ensure varying fields are read correctly throughout the model.
+
+Internally, `dWind` is able to convert the following data to adhere to internal usage:
+- Any field with "DIR" is converted to a Python `pathlib.Path` object for robust file handling
+- SQL credentials and constructor strings are automatically formed in the `[sql]` table for easier
+  construction of generic connection strings. Specifically the `{USER}` and `{PASSWORD}` fields
+  get replaced with their corresponding setting in the same table.
+
+`Configuration`, the primary class handling this data allows for dot notation and dictionary-style
+attribute calling at all levels of nesting. This means, `config.pysam.outputs.btm` and
+`config.pysam.outputs["btm"]` are equivalent. This makes for more intuitive dynamic attribute
+fetching when updating the code for varying cases.
+
+#### Run configuration
+
+The run-specific configuration should look like `examples/larimer_county_btm_baseline_2025.toml`,
+which controls all the dynamic model settings, HPC configurations, and a pointer to the primary
+model configuration described above.
+
+### Run the model
+
+`dwind` has a robust CLI interface allowing for the usage of `python path/to/dwind/dwind/run.py` or
+`dwind`. The model currently supports the run prompts:
+- `dwind run-config <run-configuration.toml>
+- `dwind run-hpc --arg1 ... --argn` where the `--arg` parameters are used in place of the run TOML
+  file.
+
+If at any point, further guidance is needed, pass `--help` to `dwind` or any of the subcommands for
+detailed information on the required and optional inputs.
+
+To run the model, it is recommended to use the following workflow from your analysis folder.
+1. Start a new `screen` session on Kestrel.
+
+   ```bash
+   screen -S <analysis-name>
+   ```
+
+2. Load your conda environment with dwind installed.
+
+   ```bash
+   module load conda
+   conda activate <env_name>
+   ```
+
+3. Navigate to your analysis folder if your relative data locations in your run configuration are
+   relative to the analysis folder.
+
+   ```bash
+   cd /path/to/analysis/location
+   ```
+
+4. Run the model.
+
+   ```bash
+   dwind run-config examples/larimer_county_btm_baseline_2025.toml
+   ```
+
+5. Disconnect your screen `Ctrl` + `a` + `d` and wait for the analysis to complete and view your
+   results.
+
+## `dwind` run settings
+
+### `run-config`
+
+```bash
+*    config_path      TEXT  Path to configuration TOML with run and model parameters. [default: None] [required]
+```
+
+### `run-hpc`
+
+```bash
+ *  --location            TEXT        The state, state_county, or priority region to run. [default: None] [required]
+ *  --sector              [fom|btm]   One of fom (front of meter) or btm (back-of-the-meter). [default: None] [required]
+ *  --scenario            [baseline]  The scenario to run (baseline is the current only option). [default: None] [required]
+ *  --year                INTEGER     The assumption year for the analysis. Options are 2022, 2024, and 2025. [default: None] [required]
+ *  --repository          TEXT        Path to the dwind repository to use when running the model. [default: None] [required]
+ *  --nodes               INTEGER     Number of HPC nodes or CPU nodes to run on. -1 indicates 75% of CPU limit. [default: None] [required]
+ *  --allocation          TEXT        HPC allocation name. [default: None] [required]
+ *  --memory              INTEGER     Node memory, in GB (HPC only). [default: None] [required]
+ *  --walltime            INTEGER     Node walltime request, in hours. [default: None] [required]
+ *  --feature             TEXT        Additional flags for the SLURM job, using formatting such as --qos=high or --depend=[state:job_id]. [default: None] [required]
+ *  --env                 TEXT        The path to the dwind Python environment that should be used to run the model. [default: None] [required]
+ *  --model-config        TEXT        Complete file name and path of the model configuration file [default: None] [required]
+ *  --dir-out             TEXT        Path to where the chunked outputs should be saved. [default: None] [required]
+ *  --stdout-path         TEXT        The path to write stdout logs. [default: None]
+```

dwind-0.3/README.md

@@ -0,0 +1,124 @@
+# Distributed Wind Generation Model (dWind)
+
+Please note that at this time the model can only be run on NREL's Kestrel HPC system. Though a
+savvy user could recreate our data in their own computing environment and update the
+internal pointers in the example configuration at `examples/larimer_county_btm_baseline_2025.toml`
+and `examples/model_config.toml`.
+
+## Installing dwind
+
+1. Install Anaconda or Miniconda (recommended) if not already installed.
+2. Clone the repository
+
+   ```bash
+   git clone https://github.com/NREL/dwind.git
+   ```
+
+3. Navigate to the dwind repository.
+
+   ```bash
+   cd /path/to/dwind
+   ```
+
+4. Create your dwind environment using our recommended settings and all required dependencies.
+
+    ```bash
+    conda env create -f environment.yml
+    ```
+
+## Running
+
+### Configuring
+
+`dWind` relies on 2 configuration files: 1) a system-wise setting that can be shared among a team,
+and 2) a run-specific configuration file. Both will be described below.
+
+#### Primary model configuration
+
+The primary model configuration should look exactly like (or be compatible with)
+`examples/model_config.toml` to ensure varying fields are read correctly throughout the model.
+
+Internally, `dWind` is able to convert the following data to adhere to internal usage:
+- Any field with "DIR" is converted to a Python `pathlib.Path` object for robust file handling
+- SQL credentials and constructor strings are automatically formed in the `[sql]` table for easier
+  construction of generic connection strings. Specifically the `{USER}` and `{PASSWORD}` fields
+  get replaced with their corresponding setting in the same table.
+
+`Configuration`, the primary class handling this data allows for dot notation and dictionary-style
+attribute calling at all levels of nesting. This means, `config.pysam.outputs.btm` and
+`config.pysam.outputs["btm"]` are equivalent. This makes for more intuitive dynamic attribute
+fetching when updating the code for varying cases.
+
+#### Run configuration
+
+The run-specific configuration should look like `examples/larimer_county_btm_baseline_2025.toml`,
+which controls all the dynamic model settings, HPC configurations, and a pointer to the primary
+model configuration described above.
+
+### Run the model
+
+`dwind` has a robust CLI interface allowing for the usage of `python path/to/dwind/dwind/run.py` or
+`dwind`. The model currently supports the run prompts:
+- `dwind run-config <run-configuration.toml>
+- `dwind run-hpc --arg1 ... --argn` where the `--arg` parameters are used in place of the run TOML
+  file.
+
+If at any point, further guidance is needed, pass `--help` to `dwind` or any of the subcommands for
+detailed information on the required and optional inputs.
+
+To run the model, it is recommended to use the following workflow from your analysis folder.
+1. Start a new `screen` session on Kestrel.
+
+   ```bash
+   screen -S <analysis-name>
+   ```
+
+2. Load your conda environment with dwind installed.
+
+   ```bash
+   module load conda
+   conda activate <env_name>
+   ```
+
+3. Navigate to your analysis folder if your relative data locations in your run configuration are
+   relative to the analysis folder.
+
+   ```bash
+   cd /path/to/analysis/location
+   ```
+
+4. Run the model.
+
+   ```bash
+   dwind run-config examples/larimer_county_btm_baseline_2025.toml
+   ```
+
+5. Disconnect your screen `Ctrl` + `a` + `d` and wait for the analysis to complete and view your
+   results.
+
+## `dwind` run settings
+
+### `run-config`
+
+```bash
+*    config_path      TEXT  Path to configuration TOML with run and model parameters. [default: None] [required]
+```
+
+### `run-hpc`
+
+```bash
+ *  --location            TEXT        The state, state_county, or priority region to run. [default: None] [required]
+ *  --sector              [fom|btm]   One of fom (front of meter) or btm (back-of-the-meter). [default: None] [required]
+ *  --scenario            [baseline]  The scenario to run (baseline is the current only option). [default: None] [required]
+ *  --year                INTEGER     The assumption year for the analysis. Options are 2022, 2024, and 2025. [default: None] [required]
+ *  --repository          TEXT        Path to the dwind repository to use when running the model. [default: None] [required]
+ *  --nodes               INTEGER     Number of HPC nodes or CPU nodes to run on. -1 indicates 75% of CPU limit. [default: None] [required]
+ *  --allocation          TEXT        HPC allocation name. [default: None] [required]
+ *  --memory              INTEGER     Node memory, in GB (HPC only). [default: None] [required]
+ *  --walltime            INTEGER     Node walltime request, in hours. [default: None] [required]
+ *  --feature             TEXT        Additional flags for the SLURM job, using formatting such as --qos=high or --depend=[state:job_id]. [default: None] [required]
+ *  --env                 TEXT        The path to the dwind Python environment that should be used to run the model. [default: None] [required]
+ *  --model-config        TEXT        Complete file name and path of the model configuration file [default: None] [required]
+ *  --dir-out             TEXT        Path to where the chunked outputs should be saved. [default: None] [required]
+ *  --stdout-path         TEXT        The path to write stdout logs. [default: None]
+```

dwind-0.3/dwind/__init__.py

@@ -0,0 +1,3 @@
+from .config import Configuration
+
+__version__ = "0.3"