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

Carpenter Workshop instructions missing from tutorials #108

Closed
williamhobbs opened this issue Sep 22, 2022 · 4 comments
Closed

Carpenter Workshop instructions missing from tutorials #108

williamhobbs opened this issue Sep 22, 2022 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@williamhobbs
Copy link
Contributor

First, this tool is awesome. Thanks for publishing and maintaining it!

I installed your package using conda install -c conda-forge herbie-data, but wasn't able to run this portion of your tutorial https://blaylockbk.github.io/Herbie/_build/html/user_guide/notebooks/data_hrrr.html without first installing Carpenter Workshop, e.g.,

pip install git+https://github.com/blaylockbk/Carpenter_Workshop.git

It might be helpful to add some additional instruction/details in the tutorials or here https://github.com/blaylockbk/Herbie#installation.

@blaylockbk
Copy link
Owner

Thanks for brining this up. Yep, I'll add that to the install instructions. The conda install is new and I haven't had a chance to update the docs yet.

The Carpenter_Workshop is not a required dependency, but I'll make that clear for the tutorials.

@blaylockbk blaylockbk added the documentation Improvements or additions to documentation label Nov 29, 2022
@blaylockbk
Copy link
Owner

blaylockbk commented Nov 29, 2022

I added a note in the Herbie install Docs that the Carpenter Workshop is an optional dependency, and also included some install instructions in the Carpenter_Workshop repo.

I'll leave this open a little longer to remind me to keep updating the Docs, especially the tutorials.

@blaylockbk
Copy link
Owner

Docs were updated. Thanks for poking me on this several months ago.

@williamhobbs
Copy link
Contributor Author

Glad to help!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

No branches or pull requests

2 participants