dsgrid
Python API for contributing to and accessing demand-side grid model (dsgrid) projects and datasets.
⚠️ dsgrid is under active development and does not yet have a formal package release. Details listed here are subject to change. Please reach out to the dsgrid coordination team with any questions or other feedback. ⚠️
Install
Virtual environment | Dependencies | from PIPY/pip | from pip+git | from cloned repository
Virtual environment
Create a virtual environment in which to install dsgrid. Anaconda or miniconda is recommended.
conda create -n dsgrid python=3.11
conda activate dsgrid
Dependencies
dsgrid uses Apache Spark to manage big data. There are no separate installation steps for Apache Spark beyond installing the dsgrid package and installing:
pip install "dsgrid-toolkit[spark]"
Otherwise installing the pyspark Python dependency handles it.
However, you should be aware that Apache Spark's Microsoft Windows support is poor and essentially limited to local mode. That is, if you use dsgrid on a Windows machine you should not attempt to install a full version of Spark nor expect to run on a Spark cluster. As such, we recommend limiting dsgrid use on Windows to browsing the registry, registering and submitting small- to medium-sized datasets, or development work with small test projects. Full dsgrid functionality with large projects requires additional computational resources, e.g., high performance or cloud computing, typically on a Linux operating system.
Additional Notes
- If pyspark complains about not finding Python, you may need to locate your python executable file (python.exe on Windows), copy it, and rename the copy to python3 (python3.exe on Windows)
Spark requires Java 8 or later with the JAVA_HOME environment variable set to the Java installation directory.
On Linux you can install OpenJDK with conda:
conda install openjdk
Windows install instructions are below.
Windows
To install Apache Spark on Windows, follow these instructions.
From PIPY/pip
pip install dsgrid-toolkit
or
pip install "dsgrid-toolkit[spark]"
From pip+git
With ssh keys:
pip install git+ssh://git@github.com/dsgrid/dsgrid.git@main
# or
pip install git+ssh://git@github.com/dsgrid/dsgrid.git@develop
From http:
pip install git+https://github.com/dsgrid/dsgrid.git@main
# or
pip install git+https://github.com/dsgrid/dsgrid.git@develop
From Cloned Repository
First, clone the repository and change into the dsgrid directory. For example:
cd ~ # or other directory where you put repositories
git clone git@github.com:dsgrid/dsgrid.git # or the http address
cd dsgrid
Then install the pacakge using the pip -e flag to directly use the files in the
cloned repository.
Users:
pip install -e .
Developers:
pip install -e '.[dev,spark]'
Usage
dsgrid is primarily a command-line interface (CLI) tool. To see the available commands:
dsgrid --help
Uninstall
pip uninstall dsgrid
If you are using a conda environment
conda deactivate
Software Record
dsgrid is developed under National Laboratory of the Rockies (formerly NREL) Software Record SWR-21-52, "demand-side grid model".
1 maintainer
Metadata
1 maintainer
Release files for dsgrid-toolkit 0.5.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| dsgrid_toolkit-0.5.1.tar.gz | 315.3 kB | With provenance | Details for dsgrid_toolkit-0.5.1.tar.gz |
Built distributions (wheels)
Total release size: 49.4 MB
Release files / dsgrid_toolkit-0.5.1.tar.gz
| Download URL | dsgrid_toolkit-0.5.1.tar.gz |
|---|---|
| Size | 315.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f355f07515322c9a7be75d2812cc737ab20f8a65fab0d662339f22c3870a20d9
|
|
BLAKE2b-256 checksum How to use checksums |
55765125d3b70614f4bea1de5db8fb06dd186029d65ccc6503d1beafbc14fc26
|
| 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 Oct 30, 2026.
Transparency logRelease files / dsgrid_toolkit-0.5.1-cp313-cp313-win_amd64.whl
| Download URL | dsgrid_toolkit-0.5.1-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 3.0 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
7db1953b32619f1ed3a8719f436620b08bc3b0fb3fa5c6783f9d991bd3fb566f
|
|
BLAKE2b-256 checksum How to use checksums |
071d4c15dea584bf4a3f4420009077745bb136358ed54c45b0d486310657cea6
|
| 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 Oct 30, 2026.
Transparency logRelease files / dsgrid_toolkit-0.5.1-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
| Download URL | dsgrid_toolkit-0.5.1-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl |
|---|---|
| Size | 3.6 MB |
| Tags | CPython 3.13 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
16f4ca5c3f61c4e4ab4f93538884842e3759232d8f786177a5766a888c7595e9
|
|
BLAKE2b-256 checksum How to use checksums |
09dd91227d3426eda3653ee0dbef88e286a4725dc2c05bdc75088c9b66322e6d
|
| 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 Oct 30, 2026.
Transparency logRelease files / dsgrid_toolkit-0.5.1-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
| Download URL | dsgrid_toolkit-0.5.1-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.whl |
|---|---|
| Size | 3.5 MB |
| Tags | CPython 3.13 Linux glibc 2.17+ ARM64 |
|
SHA-256 checksum How to use checksums |
4e23924e27296cf5a22707098948a98ccfb8fb17bfe8c9df273fe6c8ac0857d2
|
|
BLAKE2b-256 checksum How to use checksums |
bfcda1a1bca1b8c4f600373a4984f52ef00180f0883b26187a4e29e469d837c6
|
| 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 Oct 30, 2026.
Transparency logRelease files / dsgrid_toolkit-0.5.1-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | dsgrid_toolkit-0.5.1-cp313-cp313-macosx_11_0_arm64.whl |
|---|---|
| Size | 3.1 MB |
| Tags | CPython 3.13 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
0fa45da6ce713d487f43a1dd58b823b79e76c2c667a9e296ce821381d37c0d71
|
|
BLAKE2b-256 checksum How to use checksums |
dcd9c864d14e8d8d8e68abef03d613157a40a0e3dd1152f77a7e8b79c38f2a02
|
| 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 Oct 30, 2026.
Transparency logRelease files / dsgrid_toolkit-0.5.1-cp313-cp313-macosx_10_12_x86_64.whl
| Download URL | dsgrid_toolkit-0.5.1-cp313-cp313-macosx_10_12_x86_64.whl |
|---|---|
| Size | 3.2 MB |
| Tags | CPython 3.13 macOS 10.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
e6660132a846484e3afd762d18c4a35a0d5956ce348ab543d9d58a00efcf7c99
|
|
BLAKE2b-256 checksum How to use checksums |
4562e817877fe0dbccac08dca005ad4ebb2aacff7d019ab778f651fd2bbe573b
|
| 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 Oct 30, 2026.
Transparency logRelease files / dsgrid_toolkit-0.5.1-cp312-cp312-win_amd64.whl
| Download URL | dsgrid_toolkit-0.5.1-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 3.0 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
766ba9b7242f0a520467d0ed56ad5320e55e3ae9650f4dd3b15651b1e3f9cbf6
|
|
BLAKE2b-256 checksum How to use checksums |
86e72ef8bff18435c81007982afc66f4de06e70a77250ef914a3cd23f5836f30
|
| 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 Oct 30, 2026.
Transparency logRelease files / dsgrid_toolkit-0.5.1-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
| Download URL | dsgrid_toolkit-0.5.1-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl |
|---|---|
| Size | 3.6 MB |
| Tags | CPython 3.12 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
5a7c0fe707c4907e1134e0a4ce2a0fa875d0b6ce0da89e6b0f404a26b3a9e9e7
|
|
BLAKE2b-256 checksum How to use checksums |
1e80fbd1f8d46621c8336ed8dcafef73bab05d865ad15ed7b60c17bb7ea9d834
|
| 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 Oct 30, 2026.
Transparency logRelease files / dsgrid_toolkit-0.5.1-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
| Download URL | dsgrid_toolkit-0.5.1-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.whl |
|---|---|
| Size | 3.5 MB |
| Tags | CPython 3.12 Linux glibc 2.17+ ARM64 |
|
SHA-256 checksum How to use checksums |
8abd71555aa1b6290eaf4053aa718b979469b6944a5bd3221ed5e5b4b872dcc1
|
|
BLAKE2b-256 checksum How to use checksums |
042ab89d52fa491d239e872fb42e29510f574734202ed8d3e09dcc9f538cd110
|
| 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 Oct 30, 2026.
Transparency logRelease files / dsgrid_toolkit-0.5.1-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | dsgrid_toolkit-0.5.1-cp312-cp312-macosx_11_0_arm64.whl |
|---|---|
| Size | 3.1 MB |
| Tags | CPython 3.12 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
3eeb2b472e133e0a0e35ee553c11264ccd6d03707f6171f456135a1214aea152
|
|
BLAKE2b-256 checksum How to use checksums |
d5d60f5b5a4e07f4f6ed6b1367c69d99f5427c844e67d0cba4a17a9c9b4083ea
|
| 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 Oct 30, 2026.
Transparency logRelease files / dsgrid_toolkit-0.5.1-cp312-cp312-macosx_10_12_x86_64.whl
| Download URL | dsgrid_toolkit-0.5.1-cp312-cp312-macosx_10_12_x86_64.whl |
|---|---|
| Size | 3.2 MB |
| Tags | CPython 3.12 macOS 10.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
f1ac83c100e08d062fcba8d78f2783fe4e0cdb294c1fbea35f280acbe525684e
|
|
BLAKE2b-256 checksum How to use checksums |
46627ee6e69518470afe5c30706f80895c25f5b253cc46ba44f13ea27324d486
|
| 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 Oct 30, 2026.
Transparency logRelease files / dsgrid_toolkit-0.5.1-cp311-cp311-win_amd64.whl
| Download URL | dsgrid_toolkit-0.5.1-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 3.0 MB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
a8ee45c8ae59aa06f45377c28050cce3c26f297e92d166702848635836b5688e
|
|
BLAKE2b-256 checksum How to use checksums |
3f648bff0df02f7c0fe348360ba4969c40a3b13c65d35b8f61976197548c1c1a
|
| 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 Oct 30, 2026.
Transparency logRelease files / dsgrid_toolkit-0.5.1-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
| Download URL | dsgrid_toolkit-0.5.1-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl |
|---|---|
| Size | 3.6 MB |
| Tags | CPython 3.11 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
92226c6350a54dbd6fdc8623d2bd1120aa643253c09f50be4793f6fe3a6d74ed
|
|
BLAKE2b-256 checksum How to use checksums |
8656512b7db19bc7c63616cd711f496f45ef9adfdc0ccac679bf8d61ef01fb71
|
| 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 Oct 30, 2026.
Transparency logRelease files / dsgrid_toolkit-0.5.1-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
| Download URL | dsgrid_toolkit-0.5.1-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.whl |
|---|---|
| Size | 3.5 MB |
| Tags | CPython 3.11 Linux glibc 2.17+ ARM64 |
|
SHA-256 checksum How to use checksums |
aec6128656205505ddb0ec083cf57790d48f2e782f39f01e7f019efa59276c0a
|
|
BLAKE2b-256 checksum How to use checksums |
8100a933d47a2f048f678f911922af0c5df2ba5d13e857003abd7174725e3d60
|
| 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 Oct 30, 2026.
Transparency logRelease files / dsgrid_toolkit-0.5.1-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | dsgrid_toolkit-0.5.1-cp311-cp311-macosx_11_0_arm64.whl |
|---|---|
| Size | 3.1 MB |
| Tags | CPython 3.11 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
6247895a14bfff44b3f46db1b791da63fe38535f0344573d1e5d812772c17bcf
|
|
BLAKE2b-256 checksum How to use checksums |
4aed85be3aaf61fd368739dcaa9637d90a409a7426e3c5bb8533b14cd99d874b
|
| 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 Oct 30, 2026.
Transparency logRelease files / dsgrid_toolkit-0.5.1-cp311-cp311-macosx_10_12_x86_64.whl
| Download URL | dsgrid_toolkit-0.5.1-cp311-cp311-macosx_10_12_x86_64.whl |
|---|---|
| Size | 3.2 MB |
| Tags | CPython 3.11 macOS 10.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
c9b6dd5add34f967cebf2d9421f983df74bd9dcd2a80a6b926a1288d59a3309e
|
|
BLAKE2b-256 checksum How to use checksums |
d43cfdae77d169afabc78a42751110a578a38302cd66fd7e1a7488c1ff10b404
|
| 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 Oct 30, 2026.
Transparency logSecurity for dsgrid-toolkit 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
All 16 files in this release have been uploaded with provenance metadata.
Attestation for dsgrid_toolkit-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 Oct 30, 2026.
Transparency logA 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.
