From a2262bce9ecbd8a2ba957070a6d08f4942b1e4dc Mon Sep 17 00:00:00 2001 From: Mo8it Date: Wed, 6 Apr 2022 17:06:09 +0200 Subject: [PATCH] Fix README instructions --- README.adoc | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.adoc b/README.adoc index 437c3f7..168cea6 100644 --- a/README.adoc +++ b/README.adoc @@ -53,6 +53,8 @@ Pkg.update() This step has to be done by running the line above for the first time using the package to install its dependencies. Running the line above after the first time will update the installed dependencies which is optional. +This step has to be done **additionally** after activating an environment in a subdirectory. + === Import the package You can import the package by running: @@ -74,14 +76,14 @@ Initialize a simulation with 100 particles having a self-propulsion velocity of [source,julia] ---- -sim_dir = init_sim(100, 40.0) +sim_dir = init_sim(; n_particles=100, v₀=40.0) ---- Run the simulation: [source,julia] ---- -run_sim(sim_dir, duration=20.0) +run_sim(sim_dir; duration=20.0) ---- The values for the number of particles, self-propulsion velocity and simulation duration are used here as an example. For more information about possible values and other optional arguments, see the documentation of `init_sim` or `run_sim`. @@ -95,7 +97,8 @@ To generate an animation of a simulation, run the following: [source,julia] ---- -using Animation +include("visualization/Animation.jl") +using .Animation animate(sim_dir) ---- @@ -107,7 +110,8 @@ To plot only one snapshot of a simulation, run the following: [source,julia] ---- -using SnapshotPlot +include("visualization/SnapshotPlot.jl") +using .SnapshotPlot plot_snapshot(sim_dir) ---- @@ -165,7 +169,8 @@ To plot the rewards, activate the environment of the subdirectory `visualization [source,julia] ---- -using RewardsPlot +include("visualization/RewardsPlot.jl") +using .RewardsPlot plot_rewards(rl_dir) ----