pyslice

Data set templating library for model dataset creation and model running.

https://github.com/timcera/pyslice

Keywords

Keywords from Contributors

Repository

Data set templating library for model dataset creation and model running.

README.rst

.. image:: https://github.com/timcera/pyslice/actions/workflows/pypi-package.yml/badge.svg
    :alt: Tests
    :target: https://github.com/timcera/pyslice/actions/workflows/pypi-package.yml
    :height: 20

.. image:: https://img.shields.io/coveralls/github/timcera/pyslice
    :alt: Test Coverage
    :target: https://coveralls.io/r/timcera/pyslice?branch=master
    :height: 20

.. image:: https://img.shields.io/pypi/v/pyslice.svg
    :alt: Latest release
    :target: https://pypi.python.org/pypi/pyslice/
    :height: 20

.. image:: https://img.shields.io/pypi/l/pyslice.svg
    :alt: BSD-3 clause license
    :target: https://pypi.python.org/pypi/pyslice/
    :height: 20

.. image:: https://img.shields.io/pypi/dd/pyslice.svg
    :alt: pyslice downloads
    :target: https://pypi.python.org/pypi/pyslice/
    :height: 20

.. image:: https://img.shields.io/pypi/pyversions/pyslice
    :alt: PyPI - Python Version
    :target: https://pypi.org/project/pyslice/
    :height: 20

Welcome to pyslice - dataset template engine's documentation!
=============================================================
pyslice is a specialized templating system that replaces variables in
a template data set with numbers taken from all combinations of a grouped
series of numbers. It creates a dataset from input template files for each
combination of variables in the series.

The main function of pyslice is to provide utility functions for parametric
modeling. Parametric modeling is a process of varying many inputs to a model.
A drawback to parametric modeling is that there are usually hundreds to
thousands of data sets to prepare and a corresponding number of model runs.
pyslice will create the model data sets and manage the model runs, or place the
model runs in a queue managed by other software. pyslice is also useful in
establishing the sensitivity of a model to changing parameters.

Documentation
=============
Reference documentation is at https://timcera.bitbucket.io/pyslice/docs/index.html

Installation
============
pip
~~~
.. code-block:: bash

    pip install pyslice

conda
~~~~~
.. code-block:: bash

    conda install -c conda-forge pyslice

Development
===========
Development is managed on bitbucket at
https://bitbucket.org/timcera/pyslice/overview.

Owner

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: pyslice
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Timothy
    family-names: Cera
    email: tim@cerazone.net
    orcid: 'https://orcid.org/0000-0003-4613-7697'
identifiers:
  - type: url
    value: 'https://pypi.org/project/pyslice/'
    description: Python Package Index entry for pyslice
repository-code: 'https://github.com/timcera/pyslice'
url: >-
  https://timcera.bitbucket.io/pyslice/docs/index.html#pyslice-documentation
repository: 'https://bitbucket.org/timcera/pyslice/src/main/'
abstract: >-
  pyslice is a specialized templating system that replaces
  variables in a template data set with numbers taken from
  all combinations of a grouped series of numbers. It
  creates a dataset from input template files for each
  combination of variables in the series.
keywords:
  - monte-carlo
  - simulation
  - model
  - parametric
  - model-parameters
  - template
license: BSD-3-Clause

GitHub Events

Committers

Last synced: over 1 year ago

Issues and Pull Requests

Last synced: 6 months ago