.. PulsarDT documentation master file, created by sphinx-quickstart on Thu May 15 09:30:39 2025. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. :pulsardt:`PulsarDT` documentation ================================== Welcome to :pulsardt:`PulsarDT`! This guide provides all the information you need to install and run the :pulsardt:`pulsardt` Python package. For a quick start, we recommend beginning with the Getting Started page, followed by the Examples page. For more in-depth usage, please refer to the example notebooks in the examples folder. Documentation related to the source code can be found on the Modules page. .. toctree:: :maxdepth: 2 :caption: How to Guide :hidden: getting_started .. toctree:: :maxdepth: 1 :caption: Tutorial :hidden: examples .. toctree:: :maxdepth: 2 :caption: Reference :hidden: modules What can be achieved with :pulsardt:`PulsarDT`? ----------------------------------------------- 1. A modular pulsar rotator with drifting custom spark patterns. 2. Scalable data generation pipelines using Ray module 3. Interactive 3d pulsar animator visualization using vtk .. list-table:: :widths: auto :header-rows: 0 * - .. image:: /static/state_vector_multi_perspective_new.gif :alt: PulsarDT Demo :width: 300px - .. image:: /static/dispersion_graph_high_low_freq.png :alt: PulsarDT Demo :height: 250px - .. image:: /static/drifting_pulses.png :alt: PulsarDT Demo :height: 253px Acknowledgements ---------------- We gratefully acknowledge the contributions of the following individuals and institutions: - **HTW Berlin** and **PUNCH4NFDI** for project support - **Prof. Hermann Heßling** for guidance - **Yurii Pidopryhora** for valuable feedback in the Noise module - **Andrei Kazantsev** for valuable feedbacks and for providing real data Collaborations -------------- This project is a joint effort between: - HTW Berlin, Department of Computer Science - PUNCH4NFDI - MPIfRBonn - interTwin - DZA The code is hosted on GitLab and can be found at: `🔗 View on GitLab `_