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.2.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.2-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pulsarfitpy-0.2.2.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.2.tar.gz
Algorithm Hash digest
SHA256 12fa25b11d97cd23d3648f00a0cbbfdcd45276439f05685c8445d39dc7e462a1
MD5 5456402c2506419a8fc0bba6c5998268
BLAKE2b-256 4cd33e81ab2fad44d4c34530dae5243eb3285c221cb4750ac0220d2f515dfec4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pulsarfitpy-0.2.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8cba6b968a67185618b7d7512357e4c5fd0bb9c21f5f44c20746f04515267f6d
MD5 00f35e2467159af9994ef509272efbc8
BLAKE2b-256 86adcce1e9580c27dc67a3edaa30d16a9258bc5a45d83e7d77e17325616c49ee

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