Skip to main content

Text processing utilities for scientific workflows — LaTeX formatting, colored output, string parsing, and plot text helpers

Project description

SciTeX Str (scitex-str)

Text processing utilities for scientific workflows

PyPI version Tests License: AGPL-3.0

pip install scitex-str


Problem and Solution

# Problem Solution
1 LaTeX labels crash matplotlib when TeX isn't installed -- CI runners, laptops without MacTeX, Colab without !apt install texlive all fail safe_latex_render(s) -- auto-detects LaTeX; falls back to mathtext then unicode silently
2 ANSI color codes + grep/parse sprinkled as ad-hoc re patterns -- each script reinvents the wheel Grab-bag of helpers -- printc, color_text, grep, parse, replace, mask_api, readable_bytes — boring but consistent across 33 packages

Problem

Scientific Python code frequently needs LaTeX-style formatting for axis labels, colored terminal output for debugging, and structured string parsing for file paths and templates. These are scattered across ad-hoc helper functions in every project.

Solution

scitex-str provides a single package for text utilities commonly needed in scientific workflows:

  • LaTeX formatting -- convert variable names to LaTeX style, with automatic fallback when LaTeX is unavailable
  • Colored terminal output -- printc and color_text for styled console messages
  • String parsing -- bidirectional parse() to extract variables from path patterns
  • Plot text helpers -- format axis labels, titles, and tick labels for publication figures
  • Numeric formatting -- factor out common digits, human-readable byte sizes

Installation

Requires Python >= 3.10.

pip install scitex-str

SciTeX users: pip install scitex already includes this. Use import scitex then scitex.str.

Quick Start

import scitex_str as ss

# LaTeX-style formatting
ss.to_latex_style("theta")        # r"$\theta$"
ss.safe_to_latex_style("unknown") # "unknown" (no error)

# Colored terminal output
ss.printc("Success!", color="green")
ss.ct("Warning", color="yellow")  # returns colored string

# Parse structured paths
result = ss.parse("./data/Patient_23/Hour_12", "./data/Patient_{id}/Hour_{hour}")
# {'id': 23, 'hour': 12}

# Format plot text
ss.format_plot_text("amplitude_mv")  # "Amplitude [mV]"

# Human-readable bytes
ss.readable_bytes(1_500_000)  # "1.43 MB"

Part of SciTeX

scitex-str is part of SciTeX, a Python framework for scientific research automation.

Module Package Role
scitex.str scitex-str Text processing utilities
scitex.stats scitex-stats Statistical testing
scitex.io scitex-io Universal file I/O
scitex.plt figrecipe Publication-ready figures

scitex.ai

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scitex_str-0.1.2.tar.gz (41.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scitex_str-0.1.2-py3-none-any.whl (46.9 kB view details)

Uploaded Python 3

File details

Details for the file scitex_str-0.1.2.tar.gz.

File metadata

  • Download URL: scitex_str-0.1.2.tar.gz
  • Upload date:
  • Size: 41.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for scitex_str-0.1.2.tar.gz
Algorithm Hash digest
SHA256 870b28ffd870be6108b1b6bad7b191b5faf544d9e6ae4886fb818b07301f753c
MD5 8e38224ddd5b3bd3faa673dea73e72c1
BLAKE2b-256 0f19290a9da55b6f4f2b3174745e6840a93f2d8f625e167de56a8c9e4216b8f2

See more details on using hashes here.

File details

Details for the file scitex_str-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: scitex_str-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 46.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for scitex_str-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f458b56bb764ccf89fdadd48049f90208217c105fff9fd50d3917fb805e62750
MD5 6ec8dce2e00357ede95303b1e483bbe9
BLAKE2b-256 5466f484a6d6f7003255675b64f9cfee41d7d6df086a3947deaae9425447536e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page