lhcb-ntuple-wizard v1.0.2

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:

npm install

Usage

Run the project using npm:

npm start

Run the project using docker:

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:

npm install lhcb-ntuple-wizard

Usage

import React from "react";
import NtupleWizard from "lhcb-ntuple-wizard";

const App = () => {
    return (
        <NtupleWizard
            basePath="/"
            decaysPath="/decays"
            variablesPath="/variables"
            submitLocation="" // Leave empty to hide the submit button -> overrides hideDownloadButtons to false
            contactEmail="" // Leave empty to let the user fill in their email address
            hideDownloadButtons={true} // Can be overridden by submitLocation
        />
    );
};

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.