eemeter icon indicating copy to clipboard operation
eemeter copied to clipboard

Documentation is out of date

Open nmerket opened this issue 10 months ago • 8 comments

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

nmerket avatar Apr 23 '24 22:04 nmerket

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.

travis-recurve avatar Apr 24 '24 18:04 travis-recurve

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

eldritchhh avatar May 28 '24 07:05 eldritchhh

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

travis-recurve avatar May 28 '24 14:05 travis-recurve

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.

grahammarmion avatar May 28 '24 18:05 grahammarmion

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.

travis-recurve avatar May 29 '24 19:05 travis-recurve

Any updates?

eldritchhh avatar Jun 27 '24 08:06 eldritchhh

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 avatar Jul 12 '24 15:07 travis-recurve

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

travis-recurve avatar Aug 05 '24 15:08 travis-recurve