lhcb-ntuple-wizard-test 0.0.1

package/README.md

@@ -0,0 +1,79 @@
+# LHCb Ntuple Wizard
+
+LHCb Ntuple Wizard is an application to access large-scale open data from LHCb.
+
+## Table of Contents
+
+-   [Installation](#installation)
+-   [Usage](#usage)
+-   [Npm package](#npm-package)
+-   [Contributing](#contributing)
+-   [Questions](#questions)
+-   [License](#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](https://www.npmjs.com/package/lhcb-ntuple-wizard)). To install it, run the following command:
+
+```bash
+npm install lhcb-ntuple-wizard
+```
+
+### Usage
+
+```jsx
+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](https://gitlab.cern.ch/lhcb-dpa/wp6-analysis-preservation-and-open-data/lhcb-ntuple-wizard-frontend/-/issues/new).
+
+## License
+
+This project is licensed under The GNU General Public License V3.0. See [license](COPYING) for more information.

package/dist/components/App.js

@@ -0,0 +1,99 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+require("bootstrap/dist/css/bootstrap.css");
+var _react = _interopRequireDefault(require("react"));
+var _reactBootstrap = require("react-bootstrap");
+var _reactBootstrapIcons = require("react-bootstrap-icons");
+var _config = _interopRequireDefault(require("../config"));
+var _NtupleWizard = _interopRequireDefault(require("./NtupleWizard"));
+var _jsxRuntime = require("react/jsx-runtime");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/*****************************************************************************\
+* (c) Copyright 2021 CERN for the benefit of the LHCb Collaboration           *
+*                                                                             *
+* This software is distributed under the terms of the GNU General Public      *
+* Licence version 3 (GPL Version 3), copied verbatim in the file "COPYING".   *
+*                                                                             *
+* In applying this licence, CERN does not waive the privileges and immunities *
+* granted to it by virtue of its status as an Intergovernmental Organization  *
+* or submit itself to any jurisdiction.                                       *
+\*****************************************************************************/
+
+class App extends _react.default.Component {
+  render() {
+    return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_jsxRuntime.Fragment, {
+      children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_reactBootstrap.Navbar, {
+        collapseOnSelect: true,
+        expand: "lg",
+        bg: "dark",
+        variant: "dark",
+        children: /*#__PURE__*/(0, _jsxRuntime.jsxs)(_reactBootstrap.Container, {
+          children: [/*#__PURE__*/(0, _jsxRuntime.jsxs)(_reactBootstrap.Navbar.Brand, {
+            href: "/",
+            children: [/*#__PURE__*/(0, _jsxRuntime.jsx)("img", {
+              src: "/logo.svg",
+              height: "30",
+              className: "d-inline-block align-top",
+              alt: "LHCb logo"
+            }), " ", "LHCb NTuple Wizard"]
+          }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_reactBootstrap.Navbar.Toggle, {
+            "aria-controls": "responsive-navbar-nav"
+          }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_reactBootstrap.Navbar.Collapse, {
+            className: "justify-content-end",
+            children: /*#__PURE__*/(0, _jsxRuntime.jsxs)(_reactBootstrap.Nav, {
+              children: [/*#__PURE__*/(0, _jsxRuntime.jsxs)(_reactBootstrap.NavDropdown, {
+                title: "About",
+                id: "about-dropdown",
+                menuVariant: "dark",
+                children: [/*#__PURE__*/(0, _jsxRuntime.jsxs)(_reactBootstrap.NavDropdown.Item, {
+                  href: "https://lhcb-dpa.web.cern.ch/lhcb-dpa/wp6/ntupling-wizard.html",
+                  target: "_blank",
+                  children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_reactBootstrapIcons.House, {}), " Project home"]
+                }), /*#__PURE__*/(0, _jsxRuntime.jsxs)(_reactBootstrap.NavDropdown.Item, {
+                  href: "https://gitlab.cern.ch/lhcb-dpa/wp6-analysis-preservation-and-open-data/lhcb-ntuple-wizard-frontend",
+                  target: "_blank",
+                  children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_reactBootstrapIcons.CodeSlash, {}), " Source code"]
+                }), /*#__PURE__*/(0, _jsxRuntime.jsxs)(_reactBootstrap.NavDropdown.Item, {
+                  href: _config.default.metadata_baseurl,
+                  target: "_blank",
+                  children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_reactBootstrapIcons.Archive, {}), " Metadata files"]
+                })]
+              }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_reactBootstrap.Nav.Link, {
+                href: "https://opendata.cern.ch/",
+                target: "_blank",
+                children: /*#__PURE__*/(0, _jsxRuntime.jsx)("img", {
+                  src: "/open_data_portal.png",
+                  height: "30",
+                  alt: "CERN Open Data Portal"
+                })
+              })]
+            })
+          })]
+        })
+      }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_reactBootstrap.Container, {
+        className: "mt-4",
+        children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_NtupleWizard.default, {
+          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: false // Can be overridden by submitLocation
+          ,
+          hideUploadButtons: false,
+          requestReasonMessage: "Please provide a reason for your request.",
+          requestSubmittedMessage: /*#__PURE__*/(0, _jsxRuntime.jsx)(_jsxRuntime.Fragment, {
+            children: "Your request has been submitted."
+          })
+        })
+      })]
+    });
+  }
+}
+var _default = exports.default = App;

package/dist/components/ConfigDict.js

@@ -0,0 +1,103 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _reactBootstrap = require("react-bootstrap");
+var _jsxRuntime = require("react/jsx-runtime");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : String(i); }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /*****************************************************************************\
+* (c) Copyright 2021 CERN for the benefit of the LHCb Collaboration           *
+*                                                                             *
+* This software is distributed under the terms of the GNU General Public      *
+* Licence version 3 (GPL Version 3), copied verbatim in the file "COPYING".   *
+*                                                                             *
+* In applying this licence, CERN does not waive the privileges and immunities *
+* granted to it by virtue of its status as an Intergovernmental Organization  *
+* or submit itself to any jurisdiction.                                       *
+\*****************************************************************************/ //import ConfigValue from "./ConfigValue";
+/*
+ * {str:str}  -> <ConfigDict /> multiple rows of <input type="text" /> <input type="text" />
+ * {str:text} -> <ConfigDict /> multiple rows of <input type="text" /> <textarea />
+ */ /*
+ * Keys have to be unique and not empty...
+ * this may cause problems if the callback is executed on every keystroke
+ */
+class ConfigDict extends _react.default.Component {
+  constructor() {
+    super(...arguments);
+    _defineProperty(this, "state", {
+      value: JSON.stringify(this.props.value, null, 2),
+      // Object.keys(this.props.value).map((key) => [key, this.props.value[key].valueOf()]),
+      edit: false,
+      error: ""
+    });
+    _defineProperty(this, "toggleEdit", () => {
+      this.setState({
+        edit: !this.state.edit
+      });
+    });
+    _defineProperty(this, "handleSave", () => {
+      try {
+        const value = JSON.parse(this.state.value);
+        this.props.callback(value);
+        this.setState({
+          error: ""
+        });
+        this.setState({
+          edit: false
+        });
+      } catch (e) {
+        this.setState({
+          error: "".concat(e)
+        });
+      }
+    });
+    _defineProperty(this, "handleUpdate", event => {
+      const {
+        value
+      } = event.target;
+      this.setState({
+        value: value
+      });
+    });
+  }
+  render() {
+    const errorMessage = this.state.error ? /*#__PURE__*/(0, _jsxRuntime.jsx)(_reactBootstrap.Alert, {
+      variant: "danger",
+      children: this.state.error
+    }) : /*#__PURE__*/(0, _jsxRuntime.jsx)(_jsxRuntime.Fragment, {});
+    const buttonLabel = this.state.edit ? "Cancel" : "Edit";
+    const saveButton = this.state.edit ? /*#__PURE__*/(0, _jsxRuntime.jsx)(_reactBootstrap.Button, {
+      variant: "primary",
+      onClick: this.handleSave,
+      children: "Save"
+    }) : "";
+    return /*#__PURE__*/(0, _jsxRuntime.jsx)(_reactBootstrap.Card, {
+      children: /*#__PURE__*/(0, _jsxRuntime.jsxs)(_reactBootstrap.Card.Body, {
+        children: [errorMessage, /*#__PURE__*/(0, _jsxRuntime.jsx)(_reactBootstrap.FormControl, {
+          as: "textarea",
+          value: this.state.value,
+          onChange: this.handleUpdate,
+          disabled: !this.state.edit
+        }), /*#__PURE__*/(0, _jsxRuntime.jsxs)(_reactBootstrap.ButtonGroup, {
+          children: [saveButton, /*#__PURE__*/(0, _jsxRuntime.jsx)(_reactBootstrap.Button, {
+            variant: "outline-secondary",
+            onClick: this.toggleEdit,
+            children: buttonLabel
+          })]
+        })]
+      })
+    });
+  }
+}
+ConfigDict.propTypes = {
+  value: _propTypes.default.oneOfType([_propTypes.default.objectOf(_propTypes.default.string), _propTypes.default.objectOf(_propTypes.default.arrayOf(_propTypes.default.string))]),
+  callback: _propTypes.default.func
+};
+var _default = exports.default = ConfigDict;

package/dist/components/ConfigList.js

@@ -0,0 +1,94 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _ConfigValue = _interopRequireDefault(require("./ConfigValue"));
+var _reactBootstrap = require("react-bootstrap");
+var _reactBootstrapIcons = require("react-bootstrap-icons");
+var _jsxRuntime = require("react/jsx-runtime");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : String(i); }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /*****************************************************************************\
+* (c) Copyright 2021 CERN for the benefit of the LHCb Collaboration           *
+*                                                                             *
+* This software is distributed under the terms of the GNU General Public      *
+* Licence version 3 (GPL Version 3), copied verbatim in the file "COPYING".   *
+*                                                                             *
+* In applying this licence, CERN does not waive the privileges and immunities *
+* granted to it by virtue of its status as an Intergovernmental Organization  *
+* or submit itself to any jurisdiction.                                       *
+\*****************************************************************************/ /*
+ * [int]      -> <ConfigList /> multiple rows of <input type="number" step=1 />
+ * [uint]     -> <ConfigList /> multiple rows of <input type="number" step=1 min=0 />
+ * [float]    -> <ConfigList /> multiple rows of <input type="number" />
+ */
+class ConfigList extends _react.default.Component {
+  constructor() {
+    super(...arguments);
+    _defineProperty(this, "handleUpdate", index => value => {
+      let listValue = this.props.value;
+      listValue[index] = value;
+      this.props.callback(listValue);
+    });
+    _defineProperty(this, "handleAdd", () => {
+      let listValue = this.props.value;
+      const index = listValue.length;
+      if (index < this.props.defaultValue.length) {
+        const defaultValue = this.props.defaultValue[index].valueOf(); // Shallow copy
+        listValue.push(defaultValue);
+      } else {
+        listValue.push(0);
+      }
+      this.props.callback(listValue);
+    });
+    _defineProperty(this, "handleRemove", index => () => {
+      let listValue = this.props.value;
+      listValue.splice(index, 1);
+      this.props.callback(listValue);
+    });
+  }
+  render() {
+    const configurables = this.props.value.map((value, index) => {
+      const configProps = {
+        type: this.props.type,
+        value: this.props.value[index],
+        callback: this.handleUpdate(index)
+      };
+      if (index < this.props.defaultValue.length) {
+        configProps["defaultValue"] = this.props.defaultValue[index];
+      }
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_reactBootstrap.ListGroup.Item, {
+        children: /*#__PURE__*/(0, _jsxRuntime.jsxs)(_reactBootstrap.InputGroup, {
+          children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_ConfigValue.default, {
+            ...configProps
+          }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_reactBootstrap.CloseButton, {
+            onClick: this.handleRemove(index)
+          })]
+        })
+      }, index);
+    });
+    return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_jsxRuntime.Fragment, {
+      children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_reactBootstrap.ListGroup, {
+        variant: "flush",
+        children: configurables
+      }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_reactBootstrap.Button, {
+        variant: "success",
+        size: "sm",
+        onClick: this.handleAdd,
+        children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_reactBootstrapIcons.PlusLg, {})
+      })]
+    });
+  }
+}
+ConfigList.propTypes = {
+  type: _propTypes.default.string,
+  callback: _propTypes.default.func,
+  value: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.bool, _propTypes.default.number, _propTypes.default.arrayOf(_propTypes.default.string)]),
+  defaultValue: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.bool, _propTypes.default.number, _propTypes.default.arrayOf(_propTypes.default.string)])
+};
+var _default = exports.default = ConfigList;