alice/README.md

27 lines
929 B
Markdown

# curiosity
### quickstart
* `. ./jupyter.sh` runs jupyter-lab (setting everything up if necessary)
Note, run scripts using `source <scriptname>` or `. ./<scriptname>`
### helper scripts
* `. ./update_env.sh` creates or updates the project python environment
* `. ./activate_env.sh` activate the project environment (calling update if missing)
* `. ./deactivate_env.sh` deactivate the project environment
* `. ./jupyter.sh` runs jupyter-lab (calling activate for safety)
### structure
```
├── code
│   ├── agents/ # agent algorithms
│   ├── environments/ # test environments
│   └── evolve.py # sample evolution code
├── notebooks/ # example notebooks
├── papers/ # useful shared docs
├── requirements-conda.txt # conda project dependencies
├── requirements-pip.txt # pip project dependencies (sometimes necessary)
```