ska-src-maltopuft-frontend

MALTOPUFT is a prototype MAchine Learning TOolkit for PUlsars and Fast Transients. The toolkit provides several tools to enable the development of Machine Learning classifiers aiming to enhance real-time fast transient and pulsar searches at Square Kilometer Array (SKA).

This repository will hold all code relating to the MALTOPUFT frontend service. The frontend service will initially provide a GUI to inspect and label single pulse candidates identified by SKA precursor telescopes and, in the future, the SKA. For more details about MALTOPUFT, please refer to the backend service repository, ska-src-maltopuft-backend.

The frontend is developed with Javascript, React and Typescript with Vite. The interactive chart components use Plotly. The only prerequisites are Node.js and npm installations, and a modern web browser such as Firefox or Chrome.

For more information, please refer the the MALTOPUFT frontend documentation.

Quickstart

Clone the repository:

git clone --recurse-submodules git@gitlab.com:ska-telescope/src/maltopuft/ska-src-maltopuft-frontend.git

Install the dependencies and run a Vite development server:

npm install && npm run dev

View the dashboard at http://localhost:3000.

Contributing

  1. Fork (or clone) the repository (git clone --recurse-submodules git@gitlab.com:ska-telescope/src/maltopuft/ska-src-maltopuft-frontend.git)

  2. Create a feature branch (git checkout -b my-feature)

  3. Commit your changes (git commit -m 'My feature')

  4. Ensure all the pre-commit checks pass (make pre-commit)

  5. After committing all your changes, update the application version with (make bump-(major|minor|patch|rc)).

  6. Push to the remote repository (git push origin my-feature)

  7. Open a pull request