SimTool
Functions for creating and running Simulation Tools on the HUBzero platform lead by nanoHUB
Free software: MIT license
Documentation: https://simtool.readthedocs.io.
Features
Easily declare and validate inputs and outputs of a simulation using Python and Jupyter notebooks. The entire simulation code can run inside a notebook or the notebook can be a wrapper that invokes complex external codes.
Uses papermill to run parameterized notebooks, saving a new copy for each run.
Results saved in a datastore (filesystem or web service based). The datastore can be used for machine learning and statistical analysis. Additionally, it functions as a cache.
Can be containerized for remote execution.
Credits
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
History
0.1.0 (2019-08-09)
First release on PyPI.
0.2.0 (2020-03-04)
Second release on PyPI.
0.2.1 (2020-03-08)
Third release on PyPI.
0.2.2 (2020-03-08)
PyPI release with updated documentation.
0.2.3 (2020-09-21)
Improved search function to locate simTool notebook
0.3.1 (2021-06-14)
Improved input data validation
Added web service based cacheing support
0.3.2 (2021-09-22)
Fixed for use outside of HUBzero environment
0.3.3 (2021-10-04)
Improved automatic documentation generation
Fixed Image value setting
0.3.4 (2022-05-10)
Verify location of installed or published sim2L notebook
Differentiate between missing path and wrong path type (file/directory)
Stricter enforcement of param attributes
Retain directory structure when saving results.
Close open files to avoid file descriptor leakage
Added magic functions needed to run notebooks in parallel (MPI)
0.3.5 (2022-05-16)
Trap missing simToolSaveErrorOccurred and simToolAllOutputsSaved in result notebook
Return list of input files whether inputs is specified as dictionary or YAML
Add run preparation method used for web service application. Previously used external shell script
0.3.6 (2022-08-11)
Extend utility functions for getting information about input files to use either parameter or simple dictionary description.
Prepare for newer papermill versions
0.4.1 (2022-12-13)
Added new parameter classes Tag and File.
Use checksum and file size to compute sim2L run squidId.
Improve papermill efficiency by reducing implicit I/O done during execution.
Added support for sim2L metrics collection - record hit and miss by squidid.
Added getParamsFromDictionary() and content() methods to standardize processing on INPUTS in sim2L notebooks.
0.4.2 (2025-01-13)
Added updateParamsFromDictionary() methods to update params with input dictionary.
Fixed issue with updating param units attribute.
Updated dependency requirement versions.
0.4.3 (2025-05-13)
Spell check.
Allow for output in subdirectories.
Complete changeover from getParamsFromDictionary to updateParamsFromDictionary.
Add squidId to Run class.
0.4.4 (2025-05-21)
Added CacheRun class for fetching results from cache.
2 maintainers
Metadata
2 maintainers
Release files for simtool 0.4.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| simtool-0.4.4.tar.gz | 111.1 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| simtool-0.4.4-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 142.3 kB
Release files / simtool-0.4.4.tar.gz
| Download URL | simtool-0.4.4.tar.gz |
|---|---|
| Size | 111.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c68432cf0bf0b7296d2db64e697fdc5d6c4ec47591fa092ad015c7f3fb473715
|
|
BLAKE2b-256 checksum How to use checksums |
496e3ce4317bd8b865bdf04ad060d7178e773013e489ff3aa042e684c3e41626
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.4.2 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.67.1 CPython/3.8.10
|
Release files / simtool-0.4.4-py2.py3-none-any.whl
| Download URL | simtool-0.4.4-py2.py3-none-any.whl |
|---|---|
| Size | 31.2 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
aea375c8d76f2777c312db5655e3e8c5ab7792a4a92d9616b0f835a82778eef7
|
|
BLAKE2b-256 checksum How to use checksums |
01f2a36640412bcbfaddedac83a6ce922df5cbd0f7c694560a752a927141ad19
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.4.2 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.67.1 CPython/3.8.10
|
Security for simtool 0.4.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
