Skip to main content

A Python library to assist with data analysis and theoretical physics frameworks of the Australian National Telescope Facility (ATNF) Pulsar Catalogue.

Project description

pulsarfitpy

pulsarfitpy is a Python library that uses empirical data from the Australia Telescope National Facility (ATNF) database & psrqpy to predict pulsar behaviors using provided Physics Informed Neural Networks (PINNs). For more data visualization, it also offers accurate polynomial approximations of visualized datasets from two psrqpy query parameters using scikit-learn.

Prerequisites:

  • Python (>=3.12)
  • NumPy
  • Matplotlib
  • psrqpy
  • scikit-learn
  • PyTorch
  • SymPy

Install all dependencies by running the following command in the terminal:

pip install numpy matplotlib psrqpy scikit-learn torch sympy

Installation

To install the library, simply run the following in the terminal:

pip install pulsarfitpy

For library usage, import the pulsarfitpy library with:

import pulsarfitpy as pf

Refer to the documentation for further usage of the library.

Contributing

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature-name.
  3. Make your changes.
  4. Push your branch: git push origin feature-name.
  5. Create a pull request.

Credits

pulsarfitpy was written by Om Kasar, Saumil Sharma, Jonathan Sorenson, and Kason Lai.

Contact

For any questions about the repository, email contact.omkasar@gmail.com.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pulsarfitpy-0.2.1.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pulsarfitpy-0.2.1-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file pulsarfitpy-0.2.1.tar.gz.

File metadata

  • Download URL: pulsarfitpy-0.2.1.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for pulsarfitpy-0.2.1.tar.gz
Algorithm Hash digest
SHA256 42373228bd54594d04a27bb83386c760c8d6bf73af3b146b4adde4eec874e60e
MD5 9656485974e4b1ca3216abf42a62be95
BLAKE2b-256 5101121e88a12b61b82e8186315afade3da39318ae33ab3ce6b558588e41c077

See more details on using hashes here.

File details

Details for the file pulsarfitpy-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: pulsarfitpy-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 14.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for pulsarfitpy-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6cf4ed2d97e0314d661c53a545b329f8396f09a228185aeb9432fe101eabd05a
MD5 cea3009ab6b881d4b6895b9d002a3060
BLAKE2b-256 b6df7d845df716dfd0172a9e9efaa3d9a51ce372b47363de86f1d2a6096cc438

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page