Skip to content
rraadd88Public

About

🧰Streamlined scientific compute and workflow management toolkit

Topics

Resources

Stars

2 stars

Watchers

2 watching

Forks

Repository files navigation

PyPIPython build Issues
Downloads GNU License

logo

roux

Streamlined scientific compute and workflow management toolkit.
Examples

image

Usage

Examples

⌗ Dataframes.
⌗⌗ Paired Dataframes.
💾 General Input/Output.
⬤⬤ Sets.
🔤 Strings encoding/decoding.
🗃 File paths Input/Output.
🏷 Classification.
✨ Clustering.
✨ Correlations.
✨ Differences.
📈 Data fitting.
📊 Data normalization.
⬤⬤ Comparison between sets.
📈🔖Annotating visualisations.
🔧 Subplot-level adjustments.
📈 Diagrams.
📈 Distribution plots.
📈 Wrapper around Series plotting functions.
📈📈Annotating figure.
📈💾 Visualizations Input/Output.
📈 Line plots.
📈 Scatter plots.
📈⬤⬤ Plots of sets.
📈🎨✨ Visualizations theming.
⚙️🗺️ Reading multiple configs.
⚙️⏩ Running multiple tasks.
⚙️⏩ Workflow using notebooks

CLI

Requires the workflow extra (see Installation).

ℹ️ Available command line tools and their usage.
roux --help

🗺️ Read configuration.
roux read-config path/to/file

🗺️ Read metadata.
roux read-metadata path/to/file

⭐ Replace * imports in a jupyter notebook with explicit imports.
roux replacestar path/to/notebook

💾 Archive a directory to a .tar.gz (⚠️ removes the original files).
roux to-arxv path/to/directory

Installation

Using uv (recommended):

uv add roux                  # with basic dependencies
uv add "roux[all]"           # with all the additional dependencies (recommended).

With additional dependencies as required:

uv add "roux[viz]"           # for visualizations e.g. altair, upsetplot etc.
uv add "roux[data]"          # for data operations e.g. reading excel files etc.
uv add "roux[stat]"          # for statistics e.g. statsmodels etc.
uv add "roux[fast]"          # for faster processing e.g. parallelization etc.
uv add "roux[workflow]"      # for workflow operations and the `roux` CLI e.g. omegaconf etc.

Outside a uv project, use uv pip install "roux[all]", or uv tool install "roux[workflow]" for only the CLI.
Plain pip works too: pip install "roux[all]".

For development:

uv sync --all-extras         # all extras + the dev group

How to cite?

@software{Dandage_roux,
  title   = {roux: Streamlined and Versatile Data Processing Toolkit},
  author  = {Dandage, Rohan},
  year    = {2024},
  url     = {https://zenodo.org/doi/10.5281/zenodo.2682670},
  version = {0.1.2},
  note    = {The URL is a DOI link to the permanent archive of the software.},
}

Similar packages

About

🧰Streamlined scientific compute and workflow management toolkit

Topics

Resources

Stars

2 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages