Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Persefone.jl
Manage
Activity
Members
Plan
Wiki
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Locked files
Deploy
Package registry
Model registry
Operate
Terraform modules
Analyze
Contributor analytics
Repository analytics
Insights
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Persefone
Persefone.jl
Commits
dbb3c9a5
Commit
dbb3c9a5
authored
2 years ago
by
xo30xoqa
Browse files
Options
Downloads
Patches
Plain Diff
Updated README
parent
8fc84186
No related branches found
No related tags found
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
LICENSE
+1
-1
1 addition, 1 deletion
LICENSE
README.md
+11
-4
11 additions, 4 deletions
README.md
src/Persephone.jl
+3
-3
3 additions, 3 deletions
src/Persephone.jl
with
15 additions
and
8 deletions
LICENSE
+
1
−
1
View file @
dbb3c9a5
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
...
...
This diff is collapsed.
Click to expand it.
README.md
+
11
−
4
View file @
dbb3c9a5
...
...
@@ -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)
This diff is collapsed.
Click to expand it.
src/Persephone.jl
+
3
−
3
View file @
dbb3c9a5
...
...
@@ -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"
)
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment