dsgrid-toolkit 0.2.0__tar.gz

dsgrid_toolkit-0.2.0/.gitignore

@@ -0,0 +1,160 @@
+# Editor generated files #
+##########################
+.vscode
+.mypy_cache
+.idea
+cscope.files
+tags
+
+# OS generated files #
+######################
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+_build/
+
+# 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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+local-registry/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/source/api/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+poetry.lock
+
+tests/data/registry/*
+emr/running_cluster_id.txt
+emr/emr_config.yml
+spark-warehouse
+metastore_db
+__dsgrid_scratch__
+*.tgz
+*.db

dsgrid_toolkit-0.2.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2021, 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:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. 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.
+
+3. 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.

dsgrid_toolkit-0.2.0/PKG-INFO

@@ -0,0 +1,216 @@
+Metadata-Version: 2.4
+Name: dsgrid-toolkit
+Version: 0.2.0
+Summary: Python API for accessing demand-side grid model (dsgrid) datasets
+Project-URL: GitHub, https://github.com/dsgrid/dsgrid
+Project-URL: Documentation, https://dsgrid.github.io/dsgrid/
+Project-URL: Homepage, https://www.nrel.gov/analysis/dsgrid
+Author-email: Elaine Hale <elaine.hale@nrel.gov>, Lixi Liu <lixi.liu@nrel.gov>, Meghan Mooney <meghan.mooney@nrel.gov>, Daniel Thom <daniel.thom@nrel.gov>
+Maintainer-email: Elaine Hale <elaine.hale@nrel.gov>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2021, 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:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. 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.
+        
+        3. 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.
+License-File: LICENSE
+Keywords: dsgrid
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.11
+Requires-Dist: chronify~=0.3.1
+Requires-Dist: click<9,>=8.2
+Requires-Dist: dash
+Requires-Dist: dash-bootstrap-components
+Requires-Dist: duckdb<2,>=1
+Requires-Dist: fastapi
+Requires-Dist: json5
+Requires-Dist: networkx
+Requires-Dist: pandas
+Requires-Dist: prettytable
+Requires-Dist: pyarrow
+Requires-Dist: pydantic~=2.11.6
+Requires-Dist: requests
+Requires-Dist: rich-click
+Requires-Dist: semver
+Requires-Dist: sqlalchemy<3,>=2
+Requires-Dist: tzdata
+Requires-Dist: uvicorn
+Provides-Extra: dev
+Requires-Dist: devtools; extra == 'dev'
+Requires-Dist: flake8; extra == 'dev'
+Requires-Dist: httpx; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pyarrow; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Provides-Extra: doc
+Requires-Dist: autodoc-pydantic[erdantic]~=2.0; extra == 'doc'
+Requires-Dist: furo; extra == 'doc'
+Requires-Dist: ghp-import; extra == 'doc'
+Requires-Dist: numpydoc; extra == 'doc'
+Requires-Dist: pandas-stubs; extra == 'doc'
+Requires-Dist: ruff; extra == 'doc'
+Requires-Dist: sphinx-argparse~=0.4.0; extra == 'doc'
+Requires-Dist: sphinx-click~=5.0; extra == 'doc'
+Requires-Dist: sphinx-copybutton~=0.5.2; extra == 'doc'
+Requires-Dist: sphinx-tabs~=3.4; extra == 'doc'
+Requires-Dist: sphinxcontrib-programoutput; extra == 'doc'
+Requires-Dist: sphinx~=7.2; extra == 'doc'
+Provides-Extra: release
+Requires-Dist: setuptools; extra == 'release'
+Requires-Dist: twine; extra == 'release'
+Requires-Dist: wheel; extra == 'release'
+Provides-Extra: spark
+Requires-Dist: chronify[spark]; extra == 'spark'
+Requires-Dist: pyspark==4.0.0; extra == 'spark'
+Requires-Dist: thrift; extra == 'spark'
+Requires-Dist: thrift-sasl; extra == 'spark'
+Description-Content-Type: text/markdown
+
+# dsgrid
+[![Documentation](https://img.shields.io/badge/docs-ready-blue.svg)](https://dsgrid.github.io/dsgrid)
+[![codecov](https://codecov.io/gh/dsgrid/dsgrid/branch/main/graph/badge.svg?token=W0441C9XAL)](https://codecov.io/gh/dsgrid/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](#install) | [Usage](#usage) | [Uninstall](#uninstall)
+
+## Install
+
+[Virtual environment](#virtual-environment) | [Dependencies](#dependencies) | [from PIPY/pip](#from-pipypip) | [from pip+git](#from-pipgit) | [from cloned repository](#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.10
+conda activate dsgrid
+```
+
+### Dependencies
+
+dsgrid uses [Apache Spark](#https://spark.apache.org/) to manage big data. There are no separate installation steps for Apache Spark beyond installing the dsgrid package and installing:
+
+```
+pip install git+https://github.com/apache/kyuubi.git#egg=pyhive&subdirectory=python
+```
+
+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](https://towardsdatascience.com/installing-apache-pyspark-on-windows-10-f5f0c506bea1).
+
+### From PIPY/pip
+
+*Not yet available*
+
+### 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]'
+```
+
+## 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 NREL Software Record SWR-21-52, "demand-side grid model".

dsgrid_toolkit-0.2.0/README.md

@@ -0,0 +1,119 @@
+# dsgrid
+[![Documentation](https://img.shields.io/badge/docs-ready-blue.svg)](https://dsgrid.github.io/dsgrid)
+[![codecov](https://codecov.io/gh/dsgrid/dsgrid/branch/main/graph/badge.svg?token=W0441C9XAL)](https://codecov.io/gh/dsgrid/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](#install) | [Usage](#usage) | [Uninstall](#uninstall)
+
+## Install
+
+[Virtual environment](#virtual-environment) | [Dependencies](#dependencies) | [from PIPY/pip](#from-pipypip) | [from pip+git](#from-pipgit) | [from cloned repository](#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.10
+conda activate dsgrid
+```
+
+### Dependencies
+
+dsgrid uses [Apache Spark](#https://spark.apache.org/) to manage big data. There are no separate installation steps for Apache Spark beyond installing the dsgrid package and installing:
+
+```
+pip install git+https://github.com/apache/kyuubi.git#egg=pyhive&subdirectory=python
+```
+
+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](https://towardsdatascience.com/installing-apache-pyspark-on-windows-10-f5f0c506bea1).
+
+### From PIPY/pip
+
+*Not yet available*
+
+### 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]'
+```
+
+## 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 NREL Software Record SWR-21-52, "demand-side grid model".

dsgrid_toolkit-0.2.0/dsgrid/__init__.py

@@ -0,0 +1,22 @@
+import datetime as dt
+import warnings
+
+from dsgrid.dsgrid_rc import DsgridRuntimeConfig
+from dsgrid.utils.timing import timer_stats_collector  # noqa: F401
+
+__title__ = "dsgrid"
+__description__ = (
+    "Python API for registring and accessing demand-side grid model (dsgrid) datasets"
+)
+__url__ = "https://github.com/dsgrid/dsgrid"
+__version__ = "0.2.0"
+__author__ = "NREL"
+__maintainer_email__ = "elaine.hale@nrel.gov"
+__license__ = "BSD-3"
+__copyright__ = "Copyright {}, The Alliance for Sustainable Energy, LLC".format(
+    dt.date.today().year
+)
+
+warnings.filterwarnings("ignore", module="duckdb_engine")
+
+runtime_config = DsgridRuntimeConfig.load()