Skip to content

README.md

Latest commit

 

History

History
88 lines (57 loc) · 2.09 KB

README.md

File metadata and controls

88 lines (57 loc) · 2.09 KB

nmmn package

Tools for astronomy, data analysis, time series, numerical simulations, gamma-ray astronomy and more! These are modules I wrote which I find useful—for whatever reason—in my research.

List of modules available (more info here):

  • astro: astronomy
  • dsp: signal processing
  • lsd: misc. operations on arrays, lists, dictionaries and sets
  • stats: statistical methods
  • sed: spectral energy distributions
  • plots: custom plots
  • fermi: Fermi LAT analysis methods
  • bayes: Bayesian tools for dealing with posterior distributions
  • grmhd: tools for dealing with GRMHD numerical simulations
  • ml: machine learning utilities
  • finance: financial data tools

Very basic documentation for the package. Generated with Sphinx.

Installation

You have a couple of options to install the module:

1. Install using pip:

pip install nmmn

2. Install from source:

git clone https://github.com/rsnemmen/nmmn.git
cd nmmn
pip install .

3. Install with a symlink (edits take effect immediately):

git clone https://github.com/rsnemmen/nmmn.git
cd nmmn
pip install -e .

This last method is preferred if you want the latest, bleeding-edge updates in the repo.

Updating

If you installed with pip (method 1), to upgrade the package to the latest stable version use

pip install --upgrade nmmn

If you installed with the setup.py script and the develop option (method 3), use

cd /path/to/nmmn
git pull

Usage

First import the specific module that you want to use:

import nmmn.lsd

Then call the method you need. For example, to remove all nan and inf elements from a numpy array:

import numpy as np

# generates some array with nan and inf
x=np.array([1,2,np.nan,np.inf])

# removes strange elements
xok=nmmn.lsd.delweird(x)

For more examples, please refer to the examples doc.

TODO

See TODO.md.

The MIT License (MIT). Copyright (c) 2026 Rodrigo Nemmen.