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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pulsarfitpy-0.2.3.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.3.tar.gz
Algorithm Hash digest
SHA256 71b4a620da64f90a2ff25e0aad587ffd289053160ae42756c6ac288a9806b47c
MD5 8d2698a7a065cb1157acec7c117691cd
BLAKE2b-256 50fe055991bc71ae62a1a8fc551ebcdc013f298f32515a390af35cad4f9fb739

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pulsarfitpy-0.2.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f9cea205ed5dd8949f64358c8ac5e561f9e738c968426f8e1afeb4a864330b1c
MD5 82bf8222f9e2dadab8edf74127f92a6f
BLAKE2b-256 1d4c6c19544f078677a79047c9d08811e63861619700ca259183a1ef3ec11f18

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