Interactive EIC Kinematics Visualization

Web page:

⇒ JeffersonLab.github.io/kinematics ⇐

This project is a demo of interactive illustration of kinematics in the Electron-Ion Collider (EIC), focusing on deep inelastic scattering (DIS) with scattered electron visualization. The application provides dynamic controls to adjust kinematic variables such as the electron and proton beam energies, the Bjorken scaling variable (x), and the four-momentum transfer squared (Q^2).

Development

To contribute, follow these instructions to set up and run the project locally.

1. Clone the Repository

git clone https://github.com/JeffersonLab/kinematics.git
cd kinematics

2. Install Dependencies

Ensure you have Node.js installed, then run:

npm install

3. Run the Development Server

Start the development server with:

npm run dev

The app will be available at http://localhost:3000.

4. Build for Production

To build the project for deployment:

npm run build

5. Deploy to GitHub Pages

The project is configured to automatically deploy to GitHub Pages via GitHub Actions on the main branch.

You can adjust the deployment by editing: .github/workflows/pages.yml