Migrate to dmutils (#19)

Co-authored-by: Miki Verma <[email protected]>
Co-authored-by: mikivee <mikivee>

.env

@@ -0,0 +1,3 @@
+# VSCode environment file.
+
+PYTHONPATH=src

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 120

.github/workflows/lint.yml

@@ -0,0 +1,46 @@
+# Run various link checks, like flake8 and black, to make sure
+# our code remains in good shape, avoids common bugs, and follows
+# common coding  conventions.
+name: lint
+
+on:
+  push:
+    branches-ignore:
+      - main
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  linting:
+    runs-on: ubuntu-latest
+    steps:
+      #----------------------------------------------
+      #       check-out repo and set-up python
+      #----------------------------------------------
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.10.10
+      #----------------------------------------------
+      #        load pip cache if cache exists
+      #----------------------------------------------
+      - uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip
+          restore-keys: ${{ runner.os }}-pip
+      #----------------------------------------------
+      #          run isort
+      #----------------------------------------------
+      - run: python -m pip install isort
+      - run: |
+          isort --profile black ./src
+      #----------------------------------------------
+      #          run black
+      #----------------------------------------------
+      - run: python -m pip install black[jupyter]
+      - run: |
+          black ./src  --diff
+          black ./src  --check
+    

.gitignore

@@ -1,88 +1,11 @@
-# Local config files
-.idea/
-venv/
-*.iml
-
-# Jupyter notebooks
-*.ipynb*
-
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.pyxbldc
-*.py[cod]
-
-# C extensions
-*.c
-*.so
-
-# Distribution / packaging
-.Python
-env/
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-#lib/
-lib64/
-parts/
-sdist/
-var/
-*.egg-info/
-.installed.cfg
-*.egg
-
-# 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/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*,cover
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-target/
-
-# Backups
-*~
-*.DS_Store
-
-# Pycharm files
-.idea/*
-
-#VScode files
+.vscode
 .history/
 
-# archive files
-*gz
-*.zip
+# Compile python
+*.pyc
 
-#personal exploratory folder
-exploratory/private
-
-# model files
-deprecated/Yearly_model/test_model_with_preprocessing/
+# Backup files.
+*~
 
+# model files deprecated model
+deprecated/Yearly_model/test_model_with_preprocessing/

README.md

@@ -7,10 +7,8 @@ to replicate [ResStock dataset](https://resstock.nrel.gov/)
 using Surrogate Modeling.
 
 
-This code was developed and depends on Databricks. Note that there are two other version of this model that are stored in `deprecated/`: 
+This code was developed in and depends on Databricks.
 
-1. A simple feed forward network which is in `src/Yearly_model/` _(not maintained)_
-2. A CNN model that is built in a ecosystem agnostic way, which constists of all other files _(not maintained)_
-   The repo will be reorganized soon to put (2) into a subfolder and make (1) the main set of code in the outer project directory.
+More technical documentation will be added in the future, but for now see [Architechture](docs/architecture.md) and [Features & Upgrades](docs/features_upgrades.md).
 
-More technical documentation will be added in the future, but for now see [Architechture](architecture.md) and [Features & Upgrades](features_upgrades.md).
+Note that there are two other version of this model that are stored in `deprecated/` that are not being maintained.