Skip to content

Latest commit

 

History

History
148 lines (86 loc) · 9.46 KB

README.md

File metadata and controls

148 lines (86 loc) · 9.46 KB
Raw

Multiscale Solar Water Heating

Solar water heating system modeling and simulation for individual and community scale projects

Repository Content

Folder Content
mswh Python module to calculate solar irradiation on a tilted surface (mswh/system/source_and_sink.py)

Python module with simplified component models (mswh/system/components.py) for Converter (solar collectors, electric resistance heater, gas burner, photovoltaic panels, heat pump), Storage (solar thermal tank, heat pump thermal tank, conventional gas tank water heater), and Distribution (distribution and solar pump, piping losses) components

Python module with preconfigured system simulation models (mswh/system/models.py) for: base case gas tank water heaters, solar thermal water heaters (solar collector feeding a storage tank, with a tankless gas water heater backup in a new installation cases and a base case gas tank water heater in a retrofit case) and solar electric water heaters (heat pump storage tank with an electric resistance backup)

Database with component performance parameters, California specific weather data and domestic hot water end-use load profiles (mswh/comm/swh_system_input.db)

Modules to communicate with the database (mswh/comm/sql.py), unit conversion and plotting modules in mswh/tools
scripts Jupyter notebooks with preconfigured models and any side analysis if applicable
web Django web framework to configure project, parametrize components and run simulation from a web browser
docs Sphinx documentation. To build HTML or LaTeX use make html or make latex

Usage

The fastest way to explore the preset simulations is to use the MSWH System Tool notebook. In the notebook the user provides a climate zone for a project, an occupancy for each household and whether any of the occupants stay at home during the day. The notebook can then load a set of example California specific hourly domestic hot water end-use load profiles from a database, size and locate the systems. The user can now simulate the hourly system performance over a period of one representative year, visualize and explore the simulation results using time-series plots for temperature profiles, heat and power rates, or look at annual summaries. Similarly the user can model individual household solar water heating projects and base case conventional gas tank water heater systems, such that the results can be compared between the individual, community and base case systems. All simulation and sizing parameters are exposed in the notebook and the user can easily change them if needed.

If you opt to use the web framework the shortest path to explore the simulaton results after setting up a local server is to:

  • Click on Configurations on the landing page.
  • Click on Simulate for any of the example preconfigured systems (Solar Thermal New or Solar Electric). This leads the user to a visualization page with hourly timeseries results for a representative year.
  • Play with sizes and performance parameters of preconfigured components.

To configure new system types in the web framework (such as Solar Thermal Retrofit) one would need to map it through the backend analogously to the currently preconfigured systems.

Setup and Installation

  1. Make sure that pip is installed.

  2. Unless you already have conda installed, please install the lightweight option Miniconda or Anaconda software.

Simple Installation Using Conda

  1. If you are familiar with conda and experienced with virtual environments you can perform the package installation using the following set of commands:

     conda create -n mswh -c conda-forge -c plotly python=3.8 pip git-lfs jupyterlab plotly-orca
 conda activate mswh
 git lfs install
 git clone https://github.com/LBNL-ETA/MSWH.git
 cd MSWH
 pip install -e .

The examples are best explored using JupyterLab. Please check out the JupyterLab documentation for further help as needed.

Detailed Installation Steps

This section is intended for technical users that are relatively new to virtual environments or Python in general, or for users who had any issues with the simple installation instructions from the previous section. This section will show users how to utilize an alternative package management system in Python, venv.

  1. Since the repo comes with database files, please download, install and see the documentation for git large file storage.

  2. It is recommended to create a new Python environment in order to avoid interference with the system-wide Python installation, for example by using conda or venv. Depending on the approach you take, pick one of the commands below and run it in a terminal to create a new environment named, for instance, mswh.

    If you use conda from the repo clone folder run:

     conda create -n mswh python=3.8

    If you use venv, for example on Linux:

     python3.8 -m venv <path_to_env>/mswh

    With <path_to_env> as your selected folder path to store virtual environments.

  3. Now the virtual environment needs to be activated, by running one of the following commands:

    When using Anaconda or Miniconda:

     conda activate mswh

    When using venv:

     source <path_to_env>/mswh/bin/activate

    After having activated the virtual environment, the name of it should appear before the prompt in the terminal.

    For deactivating use conda deactivate or deactivate.

  4. To make use of example Jupyter notebooks one should have JupyterLab installed. To ensure the same Python kernel can be used in a Jupyter notebook, activate the virtual environment and run:

     python -m ipykernel install --user --name mswh

    Users with admin privileges can skip the --user flag.

    If you have any issues with plots not being displayed when running the example notebooks, please install the following:

     jupyter labextension install jupyterlab-plotly

  5. Clone the repository with:

     git clone https://github.com/LBNL-ETA/MSWH.git

  6. To install the necessary Python packages navigate to the setup.py directory and run:

    pip install -e .

    The -e flag is only necessary if one would like changes to the source code be reflected immediately (without having to rerun the setup.py script with every change to the source code). If you just want to run the project application, you can omit the -e flag.

  7. To use the plotting capabilities, also required when running tests, please install orca.

Django Web Framework Deployment

  1. If the installation succeeded, to run the Django application navigate to the web folder (there should be a manage.py file) and start the development server on your local machine with:

     python manage.py runserver

    Now you can open your browser and type in localhost:8000 (or 127.0.0.1:8000 if you are on a Windows machine) to start the web interface.

    Note that to build Python extensions one needs to have python3.x-dev installed.

  2. To deploy publicly create a file local_settings.py and store it in the same directory as the settings.py. Then add a constant called SECRET_KEY = '<random_string>'. The random string should be 50 characters long and can be created (on Linux) by using the following command as super user:

     </dev/urandom tr -dc '1234567890!#$?*#-.,+qwertyuiopQWERTYUIOPasdfghjklASDFGHJKLzxcvbnmZXCVBNM' | head -c50; echo ""

    An example for a good secret key is this:

    SECRET_KEY = 'O&2aYmv%)0B5#U-'9qsLTpfItC9N*V?%3L#fOHxDO,zyUm*S,U'

Contributing

Anyone may contribute features with the appropriate tests using the issue tracker, forks and pull requests. Please check out code documentation for guidance.

Automated tests

To run tests, from the MSWH folder use the following command modified according to the test module and method you intend to run:

python -m unittest mswh.{my_module}.tests.{test_my_module}.{MyModuleTests}.{test_my_method}

Publications

The code was used for the following publications:

About

The software may be distributed under the copyright and a BSD license provided in legal.md.

Milica Grahovac, Robert Hosbach, Katie Coughlin, Mohan Ganeshalingam and Hannes Gerhart created the contents of this repo in the scope of the CEC "Costs and Benefits of Community vs. Individual End-Use Infrastructure for Solar Water Heating" project.

To cite use format provided at the DOE CODE MSWH record.