Skip to content

SoftwareDefinedBuildings/mortar-analytics

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mortar Analytics Library

Welcome to the Mortar Analytics Library! This is an open source, community-driven library of portable building analytics intended to be used with the Mortar data platform.

For a complete description of the Mortar project, please visit mortardata.org

Have Questions?

  • You can create an issue
  • You can subscribe to the mailing list: mortar-users [ AT ] lists [ DOT ] eecs [ DOT ] berkeley [ DOT ] edu

How to Use

  1. Follow the Quick Start guide. This boils down to the following:

    • make an account on mortardata.org
    • clone this repository
    • install the PyMortar library with Python >= 3.5: pip install pymortar
  2. cd into the directory within mortar-analytics of the application you want to run

    cd mortar-analytics/meter_data_example
    
  3. (optional, but recommended) Install the app's dependencies using the requirements.txt in a virtual environment

    python3 -m venv venv
    source venv/bin/activate
    pip install -r requirements.txt
    
  4. Execute the application

    python -i app.py
    

    You can also execute applications inside a Jupyter notebook context, which will allow you to browse generated visualizations in the browser along with the code. The Docker container in the Quick Start (step 1) will create this environment for you

How to Contribute

See CONTRIBUTING


Mortar is a research project from UC Berkeley.

About

Repository for implementations of analytics for mortardata.org

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages