parameterrun 0.1.0__tar.gz

parameterrun-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,63 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+
+jobs:
+  test:
+    name: ${{ matrix.os }} / py${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
+        python-version: [ "3.9", "3.10", "3.11", "3.12", "3.13" ]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        run: python -m pip install uv
+
+      - name: Sync environment
+        run: uv sync
+
+      - name: Lint
+        run: uv run ruff check .
+
+#      - name: Format check
+#        run: uv run ruff format --check .
+
+#      - name: Type check
+#        run: uv run mypy
+
+      - name: Tests
+        run: uv run pytest
+
+  build:
+    name: Build package
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+
+      - name: Install uv
+        run: python -m pip install uv
+
+      - name: Sync environment
+        run: uv sync
+
+      - name: Build
+        run: uv run python -m build
+
+      - name: Check distributions
+        run: uv run twine check --strict dist/*

parameterrun-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,50 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - "v0.1.0"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+
+      - name: Install uv
+        run: python -m pip install uv
+
+      - name: Sync environment
+        run: uv sync
+
+      - name: Build distributions
+        run: uv run python -m build
+
+      - name: Check distributions
+        run: uv run twine check --strict dist/*
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

parameterrun-0.1.0/.gitignore

@@ -0,0 +1,210 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# uv files
+uv.lock

parameterrun-0.1.0/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on Keep a Changelog and the project follows Semantic Versioning.
+
+## [0.1.0] - 2026-03-25
+
+### Added
+- Initial public release of `parameterrun`

parameterrun-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Contributing
+
+Thanks for contributing to `parameterrun`.
+
+## Development setup
+
+```bash
+uv sync --group dev
+```
+
+If you do not use `uv`, create a virtual environment and install equivalent dev dependencies from `pyproject.toml`.
+
+## Run quality checks
+
+```bash
+uv run pytest
+uv run ruff check .
+uv run mypy src/parameterrun
+uv run python -m build
+uv run python -m twine check dist/*
+```
+
+## Pull request guidelines
+
+- Keep PRs focused and small when possible.
+- Add or update tests for behavior changes.
+- Update `README.md` and `CHANGELOG.md` when user-facing behavior changes.
+- Ensure all checks pass before requesting review.
+
+## Release notes
+
+- Add entries to the `[Unreleased]` section in `CHANGELOG.md`.
+- At release time, move those entries under a versioned heading.
+

parameterrun-0.1.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, David Fernandez Fernandez
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

parameterrun-0.1.0/PKG-INFO

@@ -0,0 +1,267 @@
+Metadata-Version: 2.4
+Name: parameterrun
+Version: 0.1.0
+Summary: Parallel parameter sweeps with joblib/MPI and tqdm progress bars.
+Project-URL: Homepage, https://github.com/Davtax/ParameterRun
+Project-URL: Repository, https://github.com/Davtax/ParameterRun
+Project-URL: Issues, https://github.com/Davtax/ParameterRun/issues
+Project-URL: Changelog, https://github.com/Davtax/ParameterRun/blob/main/CHANGELOG.md
+Author-email: David Fernández-Fernández <david.fernandezf@hotmail.com>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Keywords: joblib,mpi,parallel,parameter-sweep,python,scientific-computing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: joblib>=1.3
+Requires-Dist: numpy>=1.23
+Requires-Dist: tqdm>=4.66
+Provides-Extra: mpi
+Requires-Dist: mpi4py>=3.1; extra == 'mpi'
+Description-Content-Type: text/markdown
+
+# ParameterRun
+
+`parameterrun` is a lightweight utility for running parameter sweeps in Python with a simple, function-based API.
+
+It is designed for scientific and numerical workflows where you want to evaluate a function over one or more parameter
+grids, optionally in parallel, while keeping progress bars and output reshaping convenient.
+
+The package supports:
+
+- single-parameter scans
+- multi-parameter scans
+- grouped parameters that must vary together
+- parallel execution with `joblib`
+- MPI execution with `mpi4py`
+- automatic reshaping of outputs into arrays
+- functions returning either one output or multiple outputs
+
+## Installation
+
+### With `pip`
+
+```bash
+pip install parameterrun
+```
+
+### With optional MPI support
+
+```bash
+pip install parameterrun[mpi]
+```
+
+## Basic idea
+
+The main entry point is:
+
+```python
+from parameterrun import parameterrun
+```
+
+The function `parameterrun(...)` evaluates a user-defined function over a set of parameter values. The parameters to
+sweep are identified by their names exactly as they appear in the target function signature. Additional fixed arguments
+can be passed as keyword arguments.
+
+## Quick start
+
+### 1. Single parameter
+
+```python
+from parameterrun import parameterrun
+
+
+def square(x):
+    return x ** 2
+
+
+result = parameterrun(square, param_names="x", param_values=[0, 1, 2, 3], n_workers=1, )
+
+print(result)  # array([0, 1, 4, 9])
+```
+
+### 2. Multiple independent parameters
+
+This creates a Cartesian product of the parameter groups.
+
+```python
+from parameterrun import parameterrun
+
+
+def f(x, y, scale=1):
+    return scale * (x + y)
+
+
+result = parameterrun(f, param_names=["x", "y"], param_values=[[1, 2, 3], [10, 20], ], scale=2, )
+
+result = result.reshape(3, 2)
+print(result.shape)  # (3, 2)
+```
+
+### 3. Grouped parameters
+
+Parameters in the same group vary together and must have the same number of values.
+
+```python
+from parameterrun import parameterrun
+
+
+def f(x, y, z):
+    return x + y + z
+
+
+result = parameterrun(f, param_names=[["x", "y"], ["z"]], param_values=[[[1, 2], [10, 20]],  # (x, y) = (1,10), (2,20)
+                                                                         [[100, 200, 300]],  # z varies independently
+                                                                         ], n_workers=1, )
+
+result = result.reshape(2, 3)
+print(result.shape)  # (2, 3)
+```
+
+This grouped-input mode is useful when some parameters are logically linked and should not be combined independently.
+
+## Multiple outputs
+
+If the target function returns a tuple, parameterrun returns a list of arrays, one per output channel.
+
+```python
+from parameterrun import parameterrun
+
+
+def stats(x):
+    return x + 1, x ** 2
+
+
+mean_like, square_like = parameterrun(stats, param_names="x", param_values=[1, 2, 3], n_workers=1, )
+
+print(mean_like)
+# array([2, 3, 4])
+
+print(square_like)  # array([1, 4, 9])
+```
+
+If the function returns a single object, the result is returned as a single array when reshaping is possible.
+
+## Parallel backend
+
+`parameterrun` supports two execution backends:
+
+- `joblib`: a simple, local parallelization library that works well for most use cases.
+- `mpi`: a distributed parallelization approach using MPI, suitable for running on clusters or supercomputers.
+
+If `backend=None`, the package tries to detect whether MPI is available. If MPI is not available, it falls back to
+`joblib`; otherwise it uses MPI.
+
+### Joblib backend
+
+```python
+result = parameterrun(my_function, param_names=["x", "y"], param_values=[[1, 2, 3], [4, 5]], backend="joblib",
+    n_workers=-1, )
+```
+
+If `n_workers=1`, the function runs serially without spawning joblib workers.
+
+### MPI backend
+
+```python
+result = parameterrun(my_function, param_names=["x", "y"], param_values=[[1, 2, 3], [4, 5]], backend="mpi", )
+```
+
+Run the script with MPI, for example:
+
+```bash
+mpirun -n 4 python my_script.py
+```
+
+Under MPI, only rank 0 returns the final result; the other ranks return `None`.
+
+## Progress bars and verbosity
+
+By default, progress bars are enabled:
+
+```python
+result = parameterrun(my_function, param_names="x", param_values=[1, 2, 3], pbar_bool=True, )
+```
+
+You can also pass extra keyword arguments to `tqdm` through `pbar_kwargs`:
+
+```python
+result = parameterrun(my_function, param_names="x", param_values=[1, 2, 3], pbar_kwargs={"leave": False}, )
+```
+
+Verbose logging can be enabled with:
+
+```python
+result = parameterrun(my_function, param_names="x", param_values=[1, 2, 3], verbose=True, )
+```
+
+The progress-bar description is generated automatically from the function name and parameter names, unless you provide
+`desc` explicitly.
+
+## API reference
+
+`parameterrun`
+
+```python
+parameterrun(fun, param_names, param_values, n_workers=-1, pbar_bool=True, verbose=False, pbar_kwargs=None,
+    reshape=True, backend=None, desc=None, **kwargs, )
+```
+
+* `fun`: function to evaluate
+* `param_names`: parameter name or grouped parameter names
+* `param_values`: values corresponding to `param_names`
+* `n_workers`: number of workers for `joblib`
+* `pbar_bool`: enable or disable progress bars
+* `verbose`: print backend and timing information
+* `pbar_kwargs`: additional keyword arguments passed to tqdm
+* `reshape`: reshape results into arrays when possible
+* `backend`: `"joblib"`, `"mpi"`, or `None`
+* `desc`: custom progress-bar label
+* `**kwargs`: extra fixed keyword arguments forwarded to `fun`
+
+## Input formats
+
+`parameterrun` accepts three input styles.
+
+### A. Single parameter
+
+```python
+param_names = "x"
+param_values = [1, 2, 3]
+```
+
+### B. Multiple independent parameters
+
+```python
+param_names = ["x", "y"]
+param_values = [[1, 2, 3], [10, 20], ]
+```
+
+### C. Multiple groups of parameters
+
+```python
+param_names = [["x", "y"], ["z"]]
+param_values = [[[1, 2], [10, 20]], [[100, 200, 300]], ]
+```
+
+## Development checks
+
+Before opening a PR or publishing a release, run:
+
+```bash
+pytest
+ruff check .
+mypy src/parameterrun
+python -m build
+python -m twine check dist/*
+```