atompy#

atompy is a collection of functions and classes to do minor data analysis and to create plots. Plotting is done using matplotlib, data analysis is mostly done by numpy.

The source code can be found on GitHub.

Overview#

Plotting

Documentation of functionality related to manipulating matplotlib plots.

Data Analysis

Documentation of provided functionality related to data analysis, most notably Vector, Hist1d, and Hist2d

Input/Output

Documentation of convenience functions that load (from text or ROOT files) or save data (to text files).

Physics

Documentation of the physics submodule.

Examples

Examples on how to use atompy functionality.

Installation#

There are multiple ways of installing atompy.

After installation using any of these methods, you can import atompy the usual ways, e.g.,

import atompy as ap

If you properly install atompy (that is, any method but the simple drop-in), I recommend installing it in a virtual environment.

To create a virutal environment, open a terminal in your working directory, then run

python -m venv .venv

to create a virtual environment called .venv.

Activate it using a script provided in .venv/Scripts/.

Simple drop-in#

The easiest way is to download atompy.zip from GitHub and drop it into your working directory.

  1. Navigate to the GitHub Release Page.

  2. Download atompy.zip from the assets list.

  3. Extract its contents to your working directory.

This method does not install the dependencies of atompy. You’ll have to install these manually (e.g., with pip).

Using git#

pip install git+https//github.com/frekm/atompy

From source#

  1. Download the source code from the GitHub Release Page.

  2. Unpack it and run

pip install <path>/atompy-<version>/src