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.

Installation#

There are multiple ways of installing atompy:

  • Simple drop-in: Recommended if you don’t use virtual environments for your project.

  • With git: Recommended if you use virtual environments and have git installed.

  • Without git: Recommended if you use virtual environments but don’t have git installed.

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_v<version>.zip from the assets list.

  3. Extract its contents to your working directory.

  4. Install dependencies by running pip install -r requirements-atompy.txt

Using the online repository#

With git#

If you have git installed on your system, you can use it to download and install atompy using pip.

To install the latest version, use

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

To install a particular release, e.g., v5.0.0, use

pip install git+https://github.com/frekm/atompy.git@v5.0.0

You can add a line to your requirements.txt

requirements.txt#
atompy @ git+https://github.com/frekm/atompy.git        # latest version
atompy @ git+https://github.com/frekm/atompy.git@v5.0.0 # particular version

Without git#

If you don’t have git installed on your system, you need to modify the above links.

To install the latest version, use

pip install https://github.com/frekm/atompy/archive/refs/heads/main.zip

To install a particular release, e.g., v5.0.0, use

pip install https://github.com/frekm/atompy/archive/refs/tags/v5.0.0.zip

You can add a line to your requirements.txt

requirements.txt#
atompy @ https://github.com/frekm/atompy/archive/refs/heads/main.zip  # latest version
atompy @ https://github.com/frekm/atompy/archive/refs/tags/v5.0.0.zip # particular version

From source#

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

  2. Unpack it and run

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

Alternatively, if you have git installed

git clone https://github.com/frekm/atompy.git
cd atompy
pip install .