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

Mistake in documentation #116

Closed
RocioMartinez-Cillero opened this issue Apr 19, 2022 · 2 comments · Fixed by #119
Closed

Mistake in documentation #116

RocioMartinez-Cillero opened this issue Apr 19, 2022 · 2 comments · Fixed by #119

Comments

@RocioMartinez-Cillero
Copy link

I've noticed a mistake in Omniscape documentation, section "Examples", where it says:
"Finally, map normalized current flow, which is calculated as flow potential divided by cumulative current."

Based on the paper and the results I'm getting from the algorithm, it should be "cumulative current/flow potential".

@ajzellmer
Copy link

Came here to say the same thing. Also related, in User Guide > Output Options there is an error here:

write_raw_currmap: One of true, false. Defaults to true. Save the raw cumulative current map to disk? Should always be set to true unless calc_flow_potential, calc_normalized_current, or both are true and you do not need the raw current output. If true, the cumulative current map is saved to disk as a raster called "flowpotential" with either a .tif or .asc extension (see writeastifbelow) in theprojectname directory.

Should be cum_currmap.tif instead

@vlandau
Copy link
Member

vlandau commented Jun 3, 2022

Thank you @RocioMartinez-Cillero and @ajzellmer -- great catches! I'll work on a fix right now!

vlandau pushed a commit that referenced this issue Jun 3, 2022
vlandau added a commit that referenced this issue Jun 3, 2022
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 a pull request may close this issue.

3 participants