dwind 0.3__py3-none-any.whl

dwind-0.3.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,17 @@
+dwind/__init__.py,sha256=1SS8cDsZlyc8ptI9EiFCN7kRnI9sqd0sz8D78uMYL8A,55
+dwind/btm_sizing.py,sha256=cDOHWgS0Mzqyqx9mgct5M6ve33TqQFn5dU3JkFRy2gY,5016
+dwind/config.py,sha256=KdDj0FjaOLI4XqBE2Q3-SKslRGeFvo49JKFiKlj6kI4,4001
+dwind/helper.py,sha256=BCYnZYq1aKUZZ5FBEw69Et4nEspG7l7p3X4Qb0VOkV8,6285
+dwind/loader.py,sha256=DDmaI6scXK8xC15KB7I4F1yF77_vx-bvad65TIV0eik,2239
+dwind/model.py,sha256=g-MYvIGW0n_uxCQtt5Egt3MRdzuFV7DSlDpZCsaMsZg,15142
+dwind/mp.py,sha256=TSwv8ql2UtVyZfPmRgbixYbVepQUVKptHgLBgfrnT3Q,8469
+dwind/resource.py,sha256=l7Oz-yFEmRSbK1CwMUGB16URcxkr1onkKE0nJLIJgWM,6662
+dwind/run.py,sha256=3AN084jOg0XU9ArTn7LySRs6v0p64-6bQfXqVhJY3sM,8801
+dwind/scenarios.py,sha256=UOACORe_Sf0a2MialEKAHNAwXHu1bD--0B94az6VNJA,4926
+dwind/valuation.py,sha256=1QLPm-X_QsxrTHOBSoVHjWWLtafhaqNPCTa2u9sFaqI,61145
+dwind-0.3.dist-info/licenses/LICENSE.txt,sha256=a6siYqaIG9I77f9adAqiWPBgyL-MGjAorTMa5c1YtUY,1536
+dwind-0.3.dist-info/METADATA,sha256=GL6UpyyGY-kj6uy3Sf1zB7Y5rYxyFWSYUEs0nd-u_vk,6931
+dwind-0.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+dwind-0.3.dist-info/entry_points.txt,sha256=i0jOR14bQHIF8Ayw9QTQ2F_lWM9spZWApao58FpgFL4,40
+dwind-0.3.dist-info/top_level.txt,sha256=fj_esaS-KV1YSmx7yCUoXFiRJ0dHx34B876svoE7NGE,6
+dwind-0.3.dist-info/RECORD,,

dwind-0.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

dwind-0.3.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+dwind = dwind.run:app

dwind-0.3.dist-info/licenses/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.dist-info/top_level.txt

@@ -0,0 +1 @@
+dwind