Skip to content
Snippets Groups Projects
Commit dbb3c9a5 authored by xo30xoqa's avatar xo30xoqa
Browse files

Updated README

parent 8fc84186
No related branches found
No related tags found
No related merge requests found
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
......
......@@ -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
---
&copy; 2022 Daniel Vedder, Lea Kolb (MIT license)
&copy; 2022-2023 Daniel Vedder, Lea Kolb (MIT license)
......@@ -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")
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment