LHCb Ntuple Wizard

LHCb Ntuple Wizard is an application to access large-scale open data from LHCb.

Table of Contents

- Installation
- Usage
- Npm package
- Contributing
- Questions
- License

Installation

Install Node/npm: https://nodejs.org/en

Run the following command to install the dependencies:

``bash
npm install
`

Usage

#### Run the project using npm:

`bash
npm start
`

#### Run the project using docker:

`bash
docker buildx build -t ntuple-wizard .
docker run -itp 8080:8080 --rm ntuple-wizard
`

Npm package

The Ntuple Wizard is also made available as a React component through an npm package (see package here). To install it, run the following command:

`bash
npm install lhcb-ntuple-wizard
`

$3

`jsx
import NtupleWizard from "lhcb-ntuple-wizard";

const App = () => {
return (
basePath="/"
contactEmail="" // Leave empty to let the user fill in their email address
submitLocation="" // Some endpoint to submit the request to
requestReasonMessage="Please provide a reason for your request."
requestSubmittedMessage={<>Some message to display when the request is submitted}
/>
);
};

export default App;
``

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Questions

If you have any questions about the repo, please open an issue.

License

This project is licensed under The GNU General Public License V3.0. See license for more information.