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
d52262c4
Commit
d52262c4
authored
2 years ago
by
xo30xoqa
Browse files
Options
Downloads
Patches
Plain Diff
Updated README.md to explain config file workflow
parent
20ad31a5
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+8
-3
8 additions, 3 deletions
README.md
with
8 additions
and
3 deletions
README.md
+
8
−
3
View file @
d52262c4
...
...
@@ -30,8 +30,12 @@ This is the normal mode of operation. Simply execute `run.sh`, typically like so
> ./run.sh -c <config>
```
where
`<config>`
specifies the configuration file to use. The full list of commandline
arguments is:
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
configuration file is specified, Persephone will run with its default settings.)
The full list of commandline arguments is:
```
usage: run.jl [-c CONFIGFILE] [-s SEED] [-m MAPFILE] [-o OUTDIR]
...
...
@@ -65,7 +69,8 @@ Pkg.activate(".") # assuming you're in the Persephone root folder
using
Persephone
```
You can then access all Persephone functions, such as
`simulate()`
.
You can then access all Persephone functions, such as
`simulate()`
. (See
`src/Persephone.jl`
for a list of exported functions.)
---
...
...
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