Installation and Project Setup Guide

Prerequisites

Dependencies

To use all features of pulsarfitpy, install the following Python modules.

You may install these by running either one of the following commands:

pip install -r requirements.txt

pip install psrqpy numpy torch sympy typing logging matplotlib argparse scikit-learn deepxde dataclasses pathlib pandas

For the former, please ensure that you are in the correct directory containing the requirements text file.

Python Installation

Via pip

pip install pulsarfitpy

From Source

git clone https://github.com/jfk-astro/pulsarfitpy.git
cd pulsarfitpy
pip install -e .

Go CLI Installation

Build from Source

# Clone the repository
git clone https://github.com/jfk-astro/pulsarfitpy.git
cd pulsarfitpy

# Build the CLI
make build

The binary will be available at bin/pulsar-cli.exe (Windows) or bin/pulsar-cli (Unix).

Starting Your First Project Using pulsarfitpy

Python Library

Import pulsarfitpy and psrqpy into your project. Query the particular params you want and use the following pulsarfitpy methods to fit and analyze the data.

import pulsarfitpy as pf
from psrqpy import QueryATNF

# Query ATNF database
query = QueryATNF(params=['P0', 'P1'])

# Create polynomial approximation
approx = pf.PulsarApproximation(
    query=query,
    x_param='P0',
    y_param='P1',
    test_degree=5,
    log_x=True,
    log_y=True
)

# Fit and analyze
approx.fit_polynomial()
approx.compute_metrics()
approx.plot_combined_analysis()

Go CLI

The following commands are the CLI equivalent to the above Python version.

# Run analysis
./bin/pulsar-cli analyze --param1 P0 --param2 P1 --degree 5

# Fit polynomial model
./bin/pulsar-cli fit --param1 P0 --param2 P1

# Query database
./bin/pulsar-cli query --params P0,P1,DM

Python GUI

Run the following command to use the GUI.

python src/pulsarfitpy/src/pulsarfitpy/gui.py

Next Steps

← Back to Home