|Kevin Kaiser 22194147ab|
EvoCult: a digital exploration of the field for Cultural Evolution studies
Content of the project
To be completed
│EvoCult <- Project's main folder. It is initialized as a Git │ repository with a reasonable .gitignore file. │ ├── _research <- WIP scripts, code, notes, comments, │ | to-dos and anything in an alpha state. │ └── tmp <- Temporary data folder. │ ├── data <- **Immutable and add-only!** │ ├── sims <- Data resulting directly from simulations. │ ├── exp_pro <- Data from processing experiments. │ └── exp_raw <- Raw experimental data. │ ├── plots <- Self-explanatory. ├── notebooks <- Jupyter, Weave or any other mixed media notebooks. │ ├── papers <- Scientific papers resulting from the project. │ ├── scripts <- Various scripts, e.g. simulations, plotting, analysis, │ │ The scripts use the `src` folder for their base code. │ └── intro.jl <- Simple file that uses DrWatson and uses its greeting. │ ├── src <- Source code for use in this project. Contains functions, │ structures and modules that are used throughout │ the project and in multiple scripts. │ ├── README.md <- Optional top-level README for anyone using this project. ├── .gitignore <- by default ignores _research, data, plots, videos, │ notebooks and latex-compilation related files. │ ├── Manifest.toml <- Contains full list of exact package versions used currently. └── Project.toml <- Main project file, allows activation and installation. Includes DrWatson by default.
(Adapted from DrWatson documentation)
Context of the project
To be completed
Deployment of the project
To (locally) reproduce this project, do the following:
- Download this code base. Notice that raw data are typically not included in the git-history and may need to be downloaded independently. To get a copy of the dataset, contact Kevin Kaiser or Charles Pences.
- Open a Julia console and do:
julia> using Pkg julia> Pkg.add("DrWatson") # install globally, for using `quickactivate` julia> Pkg.activate("path/to/this/project") julia> Pkg.instantiate()
This will install all necessary packages for you to be able to run the scripts and everything should work out of the box, including correctly finding local paths.
You may notice that most scripts start with the commands:
using DrWatson @quickactivate "EvoCult"
which auto-activate the project and enable local path handling from DrWatson.