Development Environment Setup

Codespaces

Easiest way to get started is to use GitHub Codespaces to set up the deleopment environment and run an instance in the cloud. You have a generous amount of free credits to use for this purpose.

• Go to https://github.com/chris-boson/epilepsy, click on Code and select the Codespaces tab.
• Click on Create codespace on main
• A new browser or VSCode window will open (you can set your preference here).
• Wait for it to be loaded. It will take a few minutes.

Local

• Go to https://github.com/chris-boson/epilepsy, click on Code and select the Local tab.
• Copy the URL under HTTPS
• Clone the repository in your local machine
  • On Mac / Linux the git CLI is pre-installed and you can just run git clone https://github.com/chris-boson/epilepsy.git
  • On Windows we recommend using GitHub Desktop
• Make sure you have python3.8 installed in your system
• Install VSCode
• Run make setup-dev
• Open a new terminal and run poetry install

Running the code

• Open the workspace
  • When asked to open the workspace, click Open Workspace
  • Otherwise you can open it manually by hitting Cmd + Shift + P -> Open workspace from file and select epilepsy.code-workspace.
• Navigate in the terminal, for example to code/CodingBasics and run poetry install.

LaTeX

To compile the LaTeX doc run make setup-latex from the repository root (only required once).

To trigger it the first time

• Navigate to book/main.tex
• Cmd + Shift + P -> LaTeX Workshop: Build LaTeX project
• It should generate main.pdf (along with some auxiliary files)
• Open main.pdf and drag it to the right side of the screen (so you have code and output side-by-side)

After that it should auto recompile on each file save.