diff --git a/LICENSE b/LICENSE index 2c3e0c77eb9708d2e954c9bdfcf4cee1d24a9e0d..16d48240d58dee5cb0dad12ed932e68bc5d50a93 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT LICENSE -Copyright (c) 2022 Daniel Vedder, Lea Kolb +Copyright (c) 2022-2023 Daniel Vedder, Lea Kolb Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index bb2507f6cc7ba187636bbf712bef3a7237b72396..1916b4c5fd288f03970e7effc22b51b3ccf6d24c 100644 --- a/README.md +++ b/README.md @@ -24,15 +24,15 @@ To install package dependencies, open a Julia REPL in this folder and run ### Running from the commandline -This is the normal mode of operation. Simply execute `run.sh`, typically like so (in Linux): +This is the normal mode of operation. Simply execute `run.jl`, typically like so (in Linux): ``` -> ./run.sh -c <config> +> ./run.jl -c <config> ``` where `<config>` specifies the configuration file to use. The recommended workflow is to copy `scr/parameters.toml` to a location of your choice and edit the copy to suit -your requirements. The adapted config file can then be passed to `run.sh`. (If no +your requirements. The adapted config file can then be passed to `run.jl`. (If no configuration file is specified, Persephone will run with its default settings.) The full list of commandline arguments is: @@ -53,6 +53,13 @@ optional arguments: ``` +To run the test suite, do the following: + +``` +> cd test +> julia runtests.jl +``` + ### Running from within Julia To use the model from within Julia (either inside an interactive REPL or if you want @@ -69,4 +76,4 @@ You can then access all Persephone functions, such as `simulate()`. (See --- -© 2022 Daniel Vedder, Lea Kolb (MIT license) +© 2022-2023 Daniel Vedder, Lea Kolb (MIT license) diff --git a/src/Persephone.jl b/src/Persephone.jl index b45406d43a4701695bf769f440a13e2f41120aa1..2408f3fbaac097c71db09b09be09105830f4c6de 100644 --- a/src/Persephone.jl +++ b/src/Persephone.jl @@ -2,7 +2,7 @@ ### ### Daniel Vedder <daniel.vedder@idiv.de> ### Lea Kolb <lea-deborah.kolb@idiv.de> -### (c) 2022, licensed under the terms of the MIT license +### (c) 2022-2023, licensed under the terms of the MIT license ### ### This file defines the module/package for the Persephone model. ### To run the model, either execute `run.jl` from the commandline, @@ -43,8 +43,8 @@ const PARAMFILE = "src/parameters.toml" ## (DO NOT CHANGE THIS VALUE! Instead, specify simulation-specific configuration files ## by using the "--configfile" commandline argument, or when invoking simulate().) -## include all module files - note that the order matters -## (if file b references something from file a, it must be included later) +## include all module files (note that the order matters - if file +## b references something from file a, it must be included later) include("core/input.jl") include("core/output.jl") include("core/landscape.jl")