pyresiflex 0.2.1

PyResiFlex is a simple set of tools in Python to obtain load (plasma) Resistance from analysis of pulse reFlexions.

PyResiFlex

PyResiFlex is a simple set of tools in Python to obtain load (plasma) Resistance from analysis of pulse reFlexions.

Full user documentation (advanced installation and examples) is available on the PyResiFlex Website.

Getting Started

Install

Assuming you have Python installed, you can use pip:

pip install pyresiflex

Quick Start

Compute the voltage at the load for a 5-m cable and a time-varying resistance:

# Import necessary libraries.
import matplotlib.pyplot as plt
import numpy as np

from pyresiflex.cable.cable import PerfectCable
from pyresiflex.generator.generator_real_impedance import ConstantGenerator
from pyresiflex.load.time_varying_resistance import PlasmaResistanceLinearFall
from pyresiflex.solver.purely_resistive_solution import PurelyResistiveSolution

# Create a purely resistive solution with a time-varying load resistance.
solution = PurelyResistiveSolution(
    cable=PerfectCable(L=5, Z_c=75, c=2e8),
    generator=ConstantGenerator(R_g=1, U_g=5e3),
    load=PlasmaResistanceLinearFall(
        Z_start=1e2, Z_end=10, t_start_fall=20e-9, t_end_fall=30e-9
    ),
)

# Solve the system at specific time points.
times = np.linspace(0, 40e-9, 1000)
# Here, the solution is computed at 5 meters.
solution.solve(x=5, t=times)

# Plot the voltage response over time.
fig, ax = plt.subplots()
ax.plot(times * 1e9, solution.voltage * 1e-3, color="k")
ax.set_xlabel(r"$\mathregular{t \, [ns]}$")
ax.set_ylabel(r"$\mathregular{V \, [kV]}$")
ax.set_title("Load voltage against time")
plt.show()

Example

Example of the reproduction of the Minesi2022 experiment using PyResiFlex.

Workflow for developers/contributors

GitHub Codespaces has been set up, so you can click on this button to quickly code and run the examples:

You can also follow the instructions below to set up the project on your machine:

• First, clone the repository with git clone https://github.com/pag1pag/pyresiflex.git.
• Since this package uses uv, install it by following the instructions on their website.
• Update this Python package manager with uv self update.
• Run uv sync to create a virtual environment at .venv with the latest version of Python and all the necessary dependencies.
• To test if the package is working, run uv run pytest. All tests should pass.

Next, you just need to activate the virtual environment with:

• (macOS and Linux) source .venv/bin/activate
• (Windows) .venv\Scripts\activate

Do not forget to activate it each time you are using this project.

Before pushing to GitHub, run the following commands in a terminal (with the virtual environment activated):

1. Update dependencies with just update-env.
2. Run quality assurance checks (code linting) with just qa.
3. Run type checks with just type-check.
4. Run unit tests with just tests.
5. Run unit tests with coverage and generate a badge with just tests-cov.
6. Build the documentation with just build-docs.

You can also run just to run all the above commands in one go.

Manually building the package

If you want to install pyresiflex in another environment, you can build the package and install it with pip:

• (pyresiflex) uv build will build a wheel .whl in the folder ./dist.
• Activate another env, called other_env.
• (other_env) pip install path/to/file.whl should install pyresiflex in other_env.

Who do I talk to?

• Pierre-Antoine Goutier, Spark Cleantech & EM2C Lab, 2024–present

References

A list of references used is available in the reference section.

Note

According to Oxford Learner's Dictionaries, reflexion is an old spelling of reflection.