Merge pull request #472 from openeemeter/feature/caltrack-2.1-daily

EEmeter 4.0
openeemeter · Feb 26, 2024 · 43b84c9 · 43b84c9
2 parents b4c9247 + 742a7ad
commit 43b84c9
Show file tree

Hide file tree

Showing 143 changed files with 23,122 additions and 14,931 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,13 @@ Development
 
 * Placeholder
 
+4.0.0
+-----
+
+* Update daily model methods, API, and serialization
+* Provide new API for hourly model to match daily syntax and prepare for future additions
+* Add baseline and reporting dataclasses to support compliant initialization of meter and temperature data
+
 3.2.0
 -----
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -79,7 +79,7 @@ All source files must apply the following SPDX header:
 ``` python
 """
 
-   Copyright 2014-2023 OpenEEmeter contributors
+   Copyright 2014-2024 OpenEEmeter contributors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/LICENSE b/LICENSE
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2014-2023 OpenEEmeter contributors
+   Copyright 2014-2024 OpenEEmeter contributors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,3 +1,3 @@
 include README.rst LICENSE pytest.ini
-include eemeter/samples/*.json eemeter/samples/*.csv.gz
+include eemeter/eemeter/samples/*.json eemeter/eemeter/samples/*.csv.gz
 recursive-include tests *.py
diff --git a/Pipfile b/Pipfile
@@ -9,6 +9,11 @@ matplotlib = "*"
 statsmodels = "*"
 scipy = "*"
 pandas = ">=1.0.0"
+attrs = "*"
+numpy = "*"
+numba = "*"
+nlopt = "*"
+pydantic = ">=2.0"
 
 [dev-packages]
 sqlalchemy = "*"

diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/data/attribution.txt b/data/attribution.txt
@@ -0,0 +1,8 @@
+This data is derived from NREL's ComStock datasets (2023/comstock_amy2018_release_2)
+
+The ComStock database, part of the Open Energy Data Initiative, carries with it a Creative Commons Attribution 3.0 United States License 
+
+Data includes information from the ComStock™ dataset developed by the National Renewable Energy Laboratory (NREL) with funding from the U.S. Department of Energy (DOE).
+
+Citation:
+Parker, Andrew, et al. 2023. ComStock Reference Documentation. Golden, CO: National Renewable Energy Laboratory. NREL/TP-5500-83819. https://www.nrel.gov/docs/fy23osti/83819.pdf
diff --git a/data/features.csv b/data/features.csv
diff --git a/data/hourly_data_0.parquet b/data/hourly_data_0.parquet
diff --git a/data/hourly_data_1.parquet b/data/hourly_data_1.parquet
diff --git a/data/hourly_data_2.parquet b/data/hourly_data_2.parquet
diff --git a/data/month_loadshape.csv b/data/month_loadshape.csv
diff --git a/data/seasonal_day_of_week_loadshape.csv b/data/seasonal_day_of_week_loadshape.csv
diff --git a/data/seasonal_hourly_day_of_week_loadshape.csv b/data/seasonal_hourly_day_of_week_loadshape.csv
diff --git a/docs/conf.py b/docs/conf.py
@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 """
 
-   Copyright 2014-2023 OpenEEmeter contributors
+   Copyright 2014-2024 OpenEEmeter contributors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -37,16 +37,14 @@
 
 # -- Project information -----------------------------------------------------
 
-from eemeter import get_version
+import eemeter
 
 project = "eemeter"
-copyright = "Copyright 2014-2023 OpenEEmeter contributors"
+copyright = "Copyright 2014-2024 OpenEEmeter contributors"
 author = "Phil Ngo"
 
-# The short X.Y version
-version = get_version()
 # The full version, including alpha/beta/rc tags
-release = version
+release = eemeter.__version__
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/eemeter/__init__.py b/eemeter/__init__.py
@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 """
 
-   Copyright 2014-2023 OpenEEmeter contributors
+   Copyright 2014-2024 OpenEEmeter contributors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -18,27 +18,17 @@
 
 """
 
-import logging
+import logging as _logging
 
 from .__version__ import __title__, __description__, __url__, __version__
 from .__version__ import __author__, __author_email__, __license__
 from .__version__ import __copyright__
-from .caltrack import *
-from .derivatives import *
-from .exceptions import *
-from .features import *
-from .io import *
-from .metrics import *
-from .samples.load import *
-from .segmentation import *
-from .transform import *
-from .visualization import *
-from .warnings import *
-
-
-def get_version():
-    return __version__
 
+from .common import *
+from . import (
+    eemeter,
+    drmeter,
+)
 
 # Set default logging handler to avoid "No handler found" warnings.
-logging.getLogger(__name__).addHandler(logging.NullHandler())
+_logging.getLogger(__name__).addHandler(_logging.NullHandler())
diff --git a/eemeter/__version__.py b/eemeter/__version__.py
@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 """
 
-   Copyright 2014-2023 OpenEEmeter contributors
+   Copyright 2014-2024 OpenEEmeter contributors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -20,8 +20,8 @@
 __title__ = "eemeter"
 __description__ = "Open Energy Efficiency Meter"
 __url__ = "http://github.com/openeemeter/eemeter"
-__version__ = "3.2.0"
+__version__ = "4.0.0"
 __author__ = "Phil Ngo"
 __author_email__ = "admin@openee.io"
 __license__ = "Apache 2.0"
-__copyright__ = "Copyright 2014-2023 OpenEEmeter contributors"
+__copyright__ = "Copyright 2014-2024 OpenEEmeter contributors"
diff --git a/eemeter/caltrack/quickstart.py b/eemeter/caltrack/quickstart.py