README.md

Warning

This Python package is still under migration/development from its initial (legacy) version of August 2024.

Python package for noble liquid (e.g. liquid argon) purity monitors based on radioactive electron sources (e.g. Bi-207)

Usage

Manual.

Installation

Through pip and PyPI

Through conda

Development/editable installation

Global installation (not recommended)

Setup and install (once)

# Clone and enter the package repository
git clone https://github.com/bastienvoirin/puritymonitor.git
cd puritymonitor

# Install the `puritymonitor` package from its source in editable mode
pip install -e .

Use in Python programs

import puritymonitor

Using a virtual environment (recommended)

Setup (once)

# Clone and enter the package repository
git clone https://github.com/bastienvoirin/puritymonitor.git
cd puritymonitor

# Create a new virtual environment
python3 -m venv .venv # Unix/macOS
py -m venv .venv      # Windows

Activate (each time)

# Activate the virtual environment
source .venv/bin/activate # Unix/macOS
.venv\Scripts\activate    # Windows

Install (once)

# Install the `puritymonitor` package from its source in editable mode
pip install -e .

Use in Python programs

import puritymonitor

Deactivate (each time)

# Deactivate the virtual environment
deactivate

License

MIT License © Bastien Voirin.