Skip to main content

Distributed Wind Generation Model (dWind)

License PyPI - Version Jupyter Book Badge

Pre-commit isort Ruff

Please note that at this time the model can only be run on NatLabRockies'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

    git clone https://github.com/NatLabRockies/dwind.git
    
  3. Navigate to the dwind repository.

    cd /path/to/dwind
    
  4. Create your dwind environment using our recommended settings and all required dependencies.

    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/main.py or by directly callingdwind. For more details on using the CLI, use the --help flag, or visit our CLI documentation page https://natlabrockies.github.io/dwind/cli.html

To run the model, it is recommended to use the following workflow from your analysis folder.

  1. Start a new screen session on Kestrel.

    screen -S <analysis-name>
    
  2. Load your conda environment with dwind installed.

    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.

    cd /path/to/analysis/location
    
  4. Run the model.

    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.

Metadata

Release files for dwind 0.5.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dwind 0.5.1
File Size Uploaded Provenance Actions
dwind-0.5.1.tar.gz 2.4 MB With provenance Details for dwind-0.5.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for dwind 0.5.1
File Interpreter ABI Platform Actions
dwind-0.5.1-py3-none-any.whl Python 3 none any Details for dwind-0.5.1-py3-none-any.whl

Total release size: 2.5 MB

Release files / dwind-0.5.1.tar.gz

Download URL dwind-0.5.1.tar.gz
Size 2.4 MB
Tags Source
SHA-256 checksum
How to use checksums
f8a69fae989c6ccccb44067b971392fb02b44465bec5e359fb6c8f3b5f6376ce
BLAKE2b-256 checksum
How to use checksums
2f38ac04c3cac9d1c87172c4f54da8b84efebef157245a8f52bb1c8ef733c1db
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Release files / dwind-0.5.1-py3-none-any.whl

Download URL dwind-0.5.1-py3-none-any.whl
Size 51.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
52f4628c66e2f40bf0e7d51ddd8fd0ea2a84dc2810b5562cf9e94f386f525e58
BLAKE2b-256 checksum
How to use checksums
98771cc4812a219757b10ea739ac54db328b4eabb5486933cc745404e26859e1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Security for dwind 0.5.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for dwind-0.5.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page