Skip to content

[JOSS REVIEW] quick start references to yt are inaccurate #98

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

Closed
zingale opened this issue Aug 11, 2019 · 4 comments
Closed

[JOSS REVIEW] quick start references to yt are inaccurate #98

zingale opened this issue Aug 11, 2019 · 4 comments
Assignees

Comments

@zingale
Copy link
Contributor

zingale commented Aug 11, 2019

The quick start page:

https://enzo.readthedocs.io/en/enzo-2.6/user_guide/bootcamp.html

starts by saying:

This is an unofficial quickstart guide to using Enzo, starting from checking out the Enzo and YT sources, through to building them, then to running an example problem and looking at its output.

but no reference to the yt sources is found on the page. Further, it ends by saying:

At this point, you’ve (hopefully!) run an Enzo simulation. You should also have yt set up.

but there was no mention of helping setup yt. This should be fixed or changed.

Also, the guide says "This is an unofficial quickstart ", but these are the "official" docs, so this is a bit confusing, and suggests that perhaps there is an official quickstart somewhere?

@zingale
Copy link
Contributor Author

zingale commented Aug 16, 2019

JOSS Review: openjournals/joss-reviews#1636

@fearmayo
Copy link
Contributor

I'll take this on and roll into the same PR as #109 and #99

fearmayo pushed a commit to fearmayo/enzo-dev that referenced this issue Sep 11, 2019
@bwoshea
Copy link
Contributor

bwoshea commented Sep 12, 2019

@zingale this is addressed in PR #112 .

@zingale
Copy link
Contributor Author

zingale commented Sep 16, 2019

looks good!

@zingale zingale closed this as completed Sep 16, 2019
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

3 participants