Installation Guide

Follow these steps to run the BioSim Next-Gen interactive simulation and showcase pages locally.


📋 Prerequisites

To run the simulation locally, you only need:


🚀 Setup & Launch

1. Clone the Repository

Clone the codebase to your local machine:

git clone https://github.com/dr-richard-barker/biosim-nextgen.git
cd biosim-nextgen

2. Start the Local Server

Run the custom Python launcher script:

python3 serve.py

This starts an HTTP server on port 8000.

3. Open in Browser

Navigate to the local URL displayed in the terminal: http://localhost:8000/sim.html


🛠️ Jekyll Documentation Site (Optional)

If you wish to build or test the Jekyll documentation site locally:

1. Install Ruby and Jekyll

Make sure Ruby is installed, then install Jekyll and Bundler:

gem install jekyll bundler

2. Build the Site

Run the build command from the root directory:

jekyll build

This compiles the site assets into the _site/ folder.