Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation is out of date #491

Open
nmerket opened this issue Apr 23, 2024 · 8 comments
Open

Documentation is out of date #491

nmerket opened this issue Apr 23, 2024 · 8 comments

Comments

@nmerket
Copy link

nmerket commented Apr 23, 2024

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
Copy link
Contributor

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
Copy link

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

@travis-recurve
Copy link
Contributor

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

@grahammarmion
Copy link

grahammarmion commented May 28, 2024

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
Copy link
Contributor

travis-recurve commented May 29, 2024

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
Copy link

Any updates?

@travis-recurve
Copy link
Contributor

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
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants