Mentions légales du service

Skip to content
Snippets Groups Projects
Commit 2494be0d authored by Vincent Liard's avatar Vincent Liard
Browse files

Update the `README` file

Update the indications in the README file to somehow help
new user get Aevol compiled and started. This is certainly
not a full guide, but hopefully a collection of clues.
parent 93d5efd2
No related branches found
No related tags found
No related merge requests found
......@@ -30,28 +30,35 @@ distributions. Please visit www.aevol.fr
To take a quick tour, please take the following steps:
1) install aevol
cd into the main dir
./configure
1) Compile Aevol with the following commands:
cd aevol/build
cmake .
make
sudo make install
(see INSTALL in the main dir or run ./configure --help for more information)
In that process, you'll need development packages.
Here are the basic dependencies on a Debian system:
build-essential
cmake
zlib1g-dev
libboost-dev
libx11-dev
libboost-filesystem1.67-dev
One option to install them all at once is to run the following command:
sudo apt install build-essential cmake zlib1g-dev libboost-dev libx11-dev libboost-filesystem1.67-dev
NOTE: If you don't have sudo rights or simply don't want to install aevol
just yet, skip the "sudo make install" step and run the executables "locally"
with ../../src/aevol_create and ../../src/aevol_run
2) To run an example, e.g. basic, assuming you're in Aevol's root directory:
cd examples/basic
../../build/bin/aevol_create
../../build/bin/aevol_run
2) To run an example, cd into it then run:
aevol_create
aevol_run
The first command will create an experiment with the parameters contained
in the "param.in" file
The second command will launch the simulation for 1000 generations
(use --nbgener XXX or -n XXX to run for XXX generations)
(otherwise, use the --nb_timesteps option to specify the desired number of
generations)
For more information, please see the manpages (e.g. man aevol_create), run any
executable with the -h option (e.g. aevol_create -h) and ultimately visit
www.aevol.fr
For more information, please see the manpages in the `doc` directory
(e.g. man -l aevol_create.1),
or run any executable with the --help option
(e.g. aevol_create --help),
and ultimately visit www.aevol.fr
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment