Skip to content

Joss checklist/ Docs updates - #105

Draft
arswalid wants to merge 9 commits into
mainfrom
JOSS_checklist
Draft

Joss checklist/ Docs updates #105
arswalid wants to merge 9 commits into
mainfrom
JOSS_checklist

Conversation

@arswalid

Copy link
Copy Markdown
Collaborator

No description provided.

@arswalid

Copy link
Copy Markdown
Collaborator Author

reminder to test the docs locally

1- clone the repo
2- change to the JOSS_checklist branch
3- cd docs && make html
4- cd docs && open _build/html/index.html

@brookeslawski

Copy link
Copy Markdown
Collaborator

Is this PR a good place to incorporate miscellaneous docs changes that might be good to do in general? If so, I had wanted to suggest changing the definition of wind_direction in IO/input_schema.yaml.

wind_direction: default: 270.0 minimum: 0.0 maximum: 360.0 type: "number" description: "The direction of the wind in degrees. 0 indicates a wind blowing from North to South, 90 degrees from East to West, 180 from South to North, and 270 (default) from West to East."

The reference to cardinal directions is a bit unclear since the user might not know which X,Y,Z direction corresponds to which cardinal direction. I'd recommend changing the description to:
"The direction of the wind in degrees. 0 indicates a wind blowing from positive y to negative y, 90 degrees from positive x to negative x, 180 from negative y to positive y, and 270 (default) from negative x to positive x."

A potential issue with this definition is that I believe y is the vertical direction when running in 2D? If so, we can clarify.

If you approve, I can make this change directly.

It might also be worth adding a docs section and corresponding image on coordinate systems showing x, y, z, streamwise, spanwise, vertical, and then the tracker angle conventions?

@brookeslawski

Copy link
Copy Markdown
Collaborator

I'm noticing some inconsistencies in input parameter names. In the rendered docs online, docs/_build/html/input_schema.html shows the panel chord as panel_length, whereas the input files such as PVade/examples/panels2d.yaml show the panel chord as panel_chord. I like the use of panel_length, but do we also want to update it in all the input files?

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

Successfully merging this pull request may close these issues.

2 participants