openeemeter / eemeter

An open source python package for implementing and developing standard methods for calculating normalized metered energy consumption and avoided energy use.
http://eemeter.openee.io/
Apache License 2.0
220 stars 70 forks source link

Documentation is out of date #491

Open nmerket opened 7 months ago

nmerket commented 7 months ago

Describe the bug

The documentation at https://eemeter.openee.io/index.html doesn't reflect the latest version of the package, 4.0.

For example, trying to access functions in modules in the tutorial and the API aren't available

import eemeter
eemeter.create_caltrack_billing_design_matrix
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: module 'eemeter' has no attribute 'create_caltrack_billing_design_matrix'

Expected behavior

The documentation should reflect the current state of the software.

Additional context

None

travis-recurve commented 7 months ago

This is something that either needs to resolved.

In the meantime if you are trying to use OEEM 4.0, please refer to the tutorial in the repo.

eldritchhh commented 6 months ago

Hi everyone, does anyone know when the documentation will be updated? Thanks in advance!

travis-recurve commented 6 months ago

This is something that we are seeking to resolve at least within the next month.

grahammarmion commented 6 months ago

This is something that either needs to resolved.

In the meantime if you are trying to use OEEM 4.0, please refer to the tutorial in the repo.

Unfortunately, it seems the tutorial in the repo no longer works. "oeem.load_test_data("hourly_treatment_data")" responds with a 404 Client Error.

Any quick solutions for trouble shooting this? I'm eager to leverage this package.

travis-recurve commented 6 months ago

It's already in the repo, we just need to publish a minor bugfix version to pypi which we are doing now. The fix should be available very shortly as v4.0.2.

eldritchhh commented 5 months ago

Any updates?

travis-recurve commented 4 months ago

We're hard at work getting the new hourly model developed and included into the repo. As part of this initiative we will also be drastically revamping all documentation. These two things will be released at the same time.

travis-recurve commented 3 months ago

We've begun to improve our documentation. Here's a link to the new page.