Add more convenience functions and expand docs #15
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Expanded documentation and added:
run_init()reef_areas()collect_rep_results!()ReefModEngine.jl now checks if the user-provided path is valid before attempting to associate/load RME constants.
Previously the user input was trusted. If an incorrect path was given, there was no way of correcting it and the Julia session would need to be restarted.
An alternate approach to determining deployment densities is also included:
The first, without a density value specified, will attempt to calculate an appropriate density for the given reef area that maintains the set simulation grid size (defaulting to 10x10 - this correlates with the RMFAST10 processing option in ReefMod Engine).
The second is the previous approach, which assumes the specified density is a hard requirement, and attempts to determine an appropriate grid size (up to 100x100) to adequately represent it. Note that longer run times should be expected with larger grid sizes.