cadnaPromise
==============
.. image:: https://img.shields.io/badge/License-GPLv3-yellowgreen.svg
:target: LICENSE
:alt: License
----
``cadnaPromise`` is a precision auto-tuning software using command-line interfaces.
--------
Install
--------
To install ``cadnaPromise``, simply use the pip command in terminal:
.. parsed-literal::
pip install cadnaPromise
after that, to activate the ``cadnaPromise``, use the command in terminal:
.. parsed-literal::
init-promise
Check the if cadnaPromise is installed:
.. parsed-literal::
promise --version
-------------
Dependencies
-------------
The installation of ``cadnaPromise`` requires the the following Python libraries: ``colorlog``, ``colorama``, ``pyyaml``, ``regex``.
The compiling of ``cadnaPromise`` requires ``g++``. Please ensure the installation of above libraries for a proper running of cadnaPromise.
-------------
Usage
-------------
In terminal, simply enter the command bellow:
.. parsed-literal::
get help: promise --help | promise
get version: promise --version
run program: promise --precs=(customized precisions/built precisions) [options]
Options:
.. parsed-literal::
-h --help Show this screen.
--version Show version.
--precs=<strs> Set the precision following the built-in or cutomized precision letters [default: sd]
--conf CONF_FILE Get the configuration file [default: promise.yml]
--fp FPT_FILE Get the file for floating point number format [default: fp.json]
--output OUTPUT Set the path of the output (where the result files are put)
--verbosity VERBOSITY Set the verbosity (betwen 0 and 4 for very low level debug) [default: 1]
--log LOGFILE Set the log file (no log file if this is not defined)
--verbosityLog VERBOSITY Set the verbosity of the log file
--debug Put intermediate files into `debug/` (and `compileErrors/` for compilation errrors) and display the execution trace when an error comes
--run RUN File to be run
--compile COMMAND Command to compile the code
--files FILES List of files to be examined by Promise (by default, all the .cc files)
--nbDigits DIGITS General required number of digits
--path PATH Set the path of the project (by default, the current path)
--pause Do pause between steps
--noParsing Do not parse the C file (__PROMISE__ are replaced and that's all)
--auto enable auto-instrumentation of source code
--relError THRES use criteria of precision relative error less than THRES instead of number of digits
--noCadna will not use cadna, reference result computed in (non-stochastic) double precision
--alias ALIAS Allow aliases (examples "g++=g++-14") [default:""]
--CC Set compiler for C program [default: g++]
--CXX Set compiler for C++ program [default: g++]
-------------------
Acknowledgements
-------------------
``cadnaPromise`` is based on `Promise2 <https://gitlab.lip6.fr/hilaire/promise2>`_ (Hilaire et al), a full rewriting of the first PROMISE version (Picot et al).
This work was supported by the France 2030 NumPEx Exa-MA (ANR-22-EXNU-0002) project managed by the French National Research Agency (ANR).
``Promise2`` has been developed with the financial support of the COMET project Model-Based Condition Monitoring and Process Control Systems, hosted by the Materials Center Leoben Forschung GmbH.
Raw data
{
"_id": null,
"home_page": "https://github.com/PEQUAN/cadnaPromise",
"name": "cadnaPromise",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "computer arithmetic mixed-precision, precision auto-tuning",
"author": "LIP6 PEQUAN team",
"author_email": "thibault.hilaire@lip6.fr; fabienne.jezequel@lip6.fr",
"download_url": "https://files.pythonhosted.org/packages/20/e6/14f4b08483997c118d11f18026f1c2b9be52f1cde3760d9065ce8cb09482/cadnapromise-0.2.8.tar.gz",
"platform": null,
"description": "cadnaPromise\n==============\n\n\n\n\n.. image:: https://img.shields.io/badge/License-GPLv3-yellowgreen.svg\n :target: LICENSE\n :alt: License\n\n\n---- \n\n``cadnaPromise`` is a precision auto-tuning software using command-line interfaces.\n\n\n--------\nInstall\n--------\n\nTo install ``cadnaPromise``, simply use the pip command in terminal: \n\n.. parsed-literal::\n\n pip install cadnaPromise\n\n\nafter that, to activate the ``cadnaPromise``, use the command in terminal:\n\n.. parsed-literal::\n\n init-promise\n\n\nCheck the if cadnaPromise is installed:\n\n.. parsed-literal::\n\n promise --version\n\n\n-------------\nDependencies\n-------------\n\nThe installation of ``cadnaPromise`` requires the the following Python libraries: ``colorlog``, ``colorama``, ``pyyaml``, ``regex``.\n\nThe compiling of ``cadnaPromise`` requires ``g++``. Please ensure the installation of above libraries for a proper running of cadnaPromise.\n\n\n-------------\nUsage\n-------------\n\nIn terminal, simply enter the command bellow: \n\n.. parsed-literal::\n\n\tget help: promise --help | promise\n get version: promise --version\n\trun program: promise --precs=(customized precisions/built precisions) [options]\n\n\nOptions:\n\n.. parsed-literal::\n\n\t-h --help Show this screen.\n\t--version Show version.\n\t--precs=<strs> Set the precision following the built-in or cutomized precision letters [default: sd]\n\t--conf CONF_FILE Get the configuration file [default: promise.yml]\n\t--fp FPT_FILE Get the file for floating point number format [default: fp.json]\n\t--output OUTPUT Set the path of the output (where the result files are put)\n\t--verbosity VERBOSITY Set the verbosity (betwen 0 and 4 for very low level debug) [default: 1]\n\t--log LOGFILE Set the log file (no log file if this is not defined)\n\t--verbosityLog VERBOSITY Set the verbosity of the log file\n\t--debug Put intermediate files into `debug/` (and `compileErrors/` for compilation errrors) and display the execution trace when an error comes\n\t--run RUN File to be run\n\t--compile COMMAND Command to compile the code\n\t--files FILES List of files to be examined by Promise (by default, all the .cc files)\n\t--nbDigits DIGITS General required number of digits\n\t--path PATH Set the path of the project (by default, the current path)\n\t--pause Do pause between steps\n\t--noParsing Do not parse the C file (__PROMISE__ are replaced and that's all)\n\t--auto enable auto-instrumentation of source code\n\t--relError THRES use criteria of precision relative error less than THRES instead of number of digits\n\t--noCadna will not use cadna, reference result computed in (non-stochastic) double precision\n\t--alias ALIAS Allow aliases (examples \"g++=g++-14\") [default:\"\"]\n\t--CC \t\t\t\t Set compiler for C program [default: g++]\n\t--CXX Set compiler for C++ program [default: g++]\n\n\n-------------------\nAcknowledgements\n-------------------\n\n\n\n``cadnaPromise`` is based on `Promise2 <https://gitlab.lip6.fr/hilaire/promise2>`_ (Hilaire et al), a full rewriting of the first PROMISE version (Picot et al).\n\nThis work was supported by the France 2030 NumPEx Exa-MA (ANR-22-EXNU-0002) project managed by the French National Research Agency (ANR).\n``Promise2`` has been developed with the financial support of the COMET project Model-Based Condition Monitoring and Process Control Systems, hosted by the Materials Center Leoben Forschung GmbH.\n",
"bugtrack_url": null,
"license": "GNU General Public License v3.0",
"summary": "Precision auto-tuning of floating-point variables in program",
"version": "0.2.8",
"project_urls": {
"Homepage": "https://github.com/PEQUAN/cadnaPromise"
},
"split_keywords": [
"computer arithmetic mixed-precision",
" precision auto-tuning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "20e614f4b08483997c118d11f18026f1c2b9be52f1cde3760d9065ce8cb09482",
"md5": "8c9e018e93842ac6e9783e288d723774",
"sha256": "5d3f69cf8f0f00edd2a6e73f6582d85428d136b0633d040d6954692dd872c8ee"
},
"downloads": -1,
"filename": "cadnapromise-0.2.8.tar.gz",
"has_sig": false,
"md5_digest": "8c9e018e93842ac6e9783e288d723774",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1378324,
"upload_time": "2025-01-11T10:22:47",
"upload_time_iso_8601": "2025-01-11T10:22:47.474820Z",
"url": "https://files.pythonhosted.org/packages/20/e6/14f4b08483997c118d11f18026f1c2b9be52f1cde3760d9065ce8cb09482/cadnapromise-0.2.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-11 10:22:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PEQUAN",
"github_project": "cadnaPromise",
"github_not_found": true,
"lcname": "cadnapromise"
}
JSON
