pymagnetos 0.9

Applications for high magnetic field analysis

pymagnetos

Collection of Python tools for high magnetic field experiments analysis.

It provides libraries and apps to analyse data acquired at the LNCMI in Toulouse.

Currently available apps :

• linx : digital lock-in
• pyuson : for ultrasound experiments
• pytdo : for TDO experiments

Those are also available as a library that can be used within custom Python scripts. They use a common framework that can also be used to build other experiment-specific app.

The documention is hosted here.

Installation

For more detailed instructions, see the installation instructions.

Method 1 : as an app

If you plan to just use the graphical user interfaces, consider installing pymagnetos as a tool managed by uv, a modern Python package manager, that will install the required Python version and dependencies.

Method 1 : Click to see instructions

1. Install uv (see their official installation instructions) :
   • On Windows, enter the following command in PowerShell :

   powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
   

   • On Linux and MacOS, enter the following in a shell :

   curl -LsSf https://astral.sh/uv/install.sh | sh
   

2. From a shell (PowerShell in Windows), install pymagnetos globally :

   uv tool install pymagnetos
   

pymagnetos is now installed along its dependencies in an isolated environment with no risks to mess up with your current tools and Python versions. Its main command, pymagnetos, is made available from any shell.

Update

To upgrade to the latest version, run :

uv tool upgrade pymagnetos

Method 2 : as a library

Installing pymagnetos as a library will allow you to use it from scripts and Jupyter notebooks (e.g. you will be able to import it with import pymagnetos).

Method 2 : Click to see instructions

From a virtual environment with Python>=3.11, install pymagnetos from PyPI :

pip install pymagnetos

If you plan to use Jupyter notebooks, install pymagnetos with the Jupyter dependencies instead :

pip install pymagnetos[jupyter]

Update

To upgrade to the latest version, run, from the virtual environment :

pip install --upgrade pymagnetos

Usage

All apps and the corresponding backend libraries require a configuration file. Grab a configuration file template from the configs folder, edit it according to your settings (essentially the path to the data directory) and drag & drop in the app window.

Run an app

Once installed, the pymagnetos command should be available from the shell (PowerShell in Windows). You can check its usage with : pymagnetos --help

Which comes down to :

• Run the app for digital lock-in : pymagnetos linx
• Run the app for ultrasound experiments : pymagnetos pyuson
• Run the app for TDO experiments : pymagnetos pytdo

Tip : hit the top arrow on the keyboard to show previous commands you ran.

You can then drag & drop your configuration file in the window and click some buttons !

Use in a script

Subpackages (e.g. pyuson or pytdo) can be imported in Python scripts or Jupyter notebooks. There are some examples in the examples folder. You can copy them and edit them according to your need.

To run the examples, matplotlib is required to display the figures. Install it with :

pip install matplotlib

To open and run the notebooks (file with the .ipynb extension), the Jupyter package needs to be installed, along with a package to make the figures interactive. If pymagnetos was installed with the [jupyter] extra, they are already installed. Otherwise, install those packages with :

pip install jupyter matplotlib ipympl

To open a Jupyter notebook, open the Jupyter Lab web interface :

jupyter lab

Then, browse to your .ipynb file and run it ! Alternatively, Visual Studio Code supports Jupyter notebooks natively through the Jupyter extension.

Acknowledgments

pymagnetos is developed in the Laboratoire National des Champs Magnétiques Intenses (LNCMI) in Toulouse, France, with the support of the OSCARS HiMagnetOS project.