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: An Efficient Physics Informed Framework for Pulsar Analysis

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.4.tar.gz (14.6 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.4-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pulsarfitpy-0.2.4.tar.gz
  • Upload date:
  • Size: 14.6 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.4.tar.gz
Algorithm Hash digest
SHA256 d584931012a8c4fc906915c3f3cfdcf89e8278d8426e3b1a3bf294e0180e9ac4
MD5 a229fe0c38b9084149c70939708b1a69
BLAKE2b-256 70d68dc0cc95b2aaa554a1de938838f1f941154ef930eb0f57ab9b918cf23716

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pulsarfitpy-0.2.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ddc00d68c3572b191f7253586990c2a19d4656a7a23f27ff0eef99beab646e21
MD5 e7bb11342f40cfa6c4f4bf81061625b0
BLAKE2b-256 5c9c77b514a908100f5bc5bcbde4d4462c62adeb435d822f254a917726301518

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