{"id":19863436,"url":"https://github.com/sandialabs/streeq","last_synced_at":"2026-06-10T00:31:29.778Z","repository":{"id":191445282,"uuid":"684670474","full_name":"sandialabs/StREEQ","owner":"sandialabs","description":"Repository for the verification code StREEQ","archived":false,"fork":false,"pushed_at":"2024-11-11T22:42:22.000Z","size":2368,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-11T15:24:02.176Z","etag":null,"topics":["scr-2729","snl-data-analysis"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sandialabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-29T16:05:32.000Z","updated_at":"2024-11-12T16:11:57.000Z","dependencies_parsed_at":"2025-01-11T15:24:02.776Z","dependency_job_id":"14503fcd-dbd3-4f2c-a51f-808657015798","html_url":"https://github.com/sandialabs/StREEQ","commit_stats":{"total_commits":2,"total_committers":1,"mean_commits":2.0,"dds":0.0,"last_synced_commit":"29485a94dbf55274838d37d03af32f35811b80e3"},"previous_names":["sandialabs/streeq"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sandialabs%2FStREEQ","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sandialabs%2FStREEQ/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sandialabs%2FStREEQ/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sandialabs%2FStREEQ/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sandialabs","download_url":"https://codeload.github.com/sandialabs/StREEQ/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241272625,"owners_count":19937091,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["scr-2729","snl-data-analysis"],"created_at":"2024-11-12T15:14:40.314Z","updated_at":"2026-06-10T00:31:29.744Z","avatar_url":"https://github.com/sandialabs.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# StREEQ\n\nNumerical error estimation for stochastic and deterministic code responses.\n\n## Usage\n\nStREEQ has one main executable, the main script `streeq`. To use this executable, you need to ensure you have the correct environment loaded (see Environment section).\nRun\n\n```\n$ streeq -h\n```\n\nto see available options.\n\n## Versions\n\nThis project will use [Semantic Versioning](https://semver.org/).\nThe StREEQ development team will support the latest minor version series with bugfixes (e.g., once version `1.1.0` is\nreleased, no bugfixes will be backported to the `1.0.z` series).\n\nStREEQ development versions will be in the form `x.y_dev`, e.g. `0.11_dev` when the latest released version begins with\n`0.11`.\n\n\n### Branches\n\nThe following branches will be maintained in the repo:\n* `master` -- stable version, points to latest release.\n* `develop` -- latest development version.\n* `releases/vX.Y` -- for example, `releases/v0.11`, `releases/v1.0`.  Contains a snapshot preparatory to releasing on\n  this minor version series.\n\n## Environment\n\nStREEQ uses a conda environment to manage its dependencies. This section gives detail on what the environment contains, and how to set up your own if\nneeded.\n\n### Dependencies\n\n* `numpy` -- basic scientific computing tools\n* `scipy` -- basic scientific computing tools\n* `pyyaml` -- read and write YAML files\n* `pandas` -- data analysis and manipulation\n* `matplotlib` -- plotting\n* `cvxopt` -- linear optimization\n* `mpi4py` -- MPI execution\n* `pytest` -- unit testing framework\n\n### Setup\n\nEdit `~/.condarc` to contain the following if you are not satisfied with the defaults:\n```\nenvs_dirs:          # defaults to ~/.conda/envs\n- /path/to/conda/envs\npkgs_dirs:          # defaults to ~/.conda/pkgs\n- /path/to/conda/pkgs\n```\n\nThen run the following conda commands:\n```\n$ conda create -n streeq python=3.9.7\n$ conda install -n streeq numpy scipy pyyaml pandas matplotlib cvxopt mpi4py pytest\n```\n\n## Running unit tests\n\nStREEQ uses the [pytest](https://pytest.org) framework for unit testing sections of the code.\n\nAll unit tests can be executed by running the script `run_unit_tests`, located in the `tests` folder.\nThe script is set up to work correctly when run from any directory.\nNote that a StREEQ environment must be loaded for the tests to run.\n\nSome notes on organization:\n* Unit tests are located in `tests/unit`\n* The `Util` directory contains common unit test utilities, other directories contain tests and their associated\n  datasets.\n\n## Running regression tests\n\nStREEQ uses [vvtest](https://github.com/sandialabs/vvtest) to run end-to-end regression tests of StREEQ.\n\nThe regression tests can be executed by navigating to `tests/regression` and running `vvtest`.\nNote that this requires a StREEQ environment to be loaded and `vvtest` to be present in the `PATH`.\nBoth requirements are satisfied by loading any StREEQ module on Sandia computing resources.\n\n## Release process\n\n* Start a new `releases/vX.Y` branch from the tip of develop with the appropriate major/minor version number for the\n  next release.\n* Change the version number (`__version__` variable in `core/StREEQ.py`).\n* If any bugs appear before the release, cherry-pick the bugfix commits from develop to this branch.\n* Once the release is ready, merge it on to master, and tag the commit on the master branch with the version number in\n  the format `vX.Y.Z`.\n* If new bugfixes are required before the next minor release, cherry-pick them onto `releases/vX.Y`, increment the\n  patch version (Z) by one, and merge to master, tagging as appropriate.\n* Follow StREEQ Installer instruction to update the StREEQ module.\n* After starting the `releases/vX.Y` branch, increment the version on the develop branch to `X.Y_dev`.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsandialabs%2Fstreeq","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsandialabs%2Fstreeq","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsandialabs%2Fstreeq/lists"}