{"id":15358611,"url":"https://github.com/tupui/batman","last_synced_at":"2026-01-07T10:04:06.748Z","repository":{"id":55117556,"uuid":"194218839","full_name":"tupui/batman","owner":"tupui","description":"batman, uncertainty quantification made easy. Any solver, non intrusive.","archived":false,"fork":false,"pushed_at":"2021-01-08T20:41:07.000Z","size":40603,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-01T22:29:10.691Z","etag":null,"topics":["bayesian-optimization","optimization","python","sensitivity-analysis","uncertainty"],"latest_commit_sha":null,"homepage":"","language":"GLSL","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/tupui.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-06-28T06:23:42.000Z","updated_at":"2023-06-09T08:43:00.000Z","dependencies_parsed_at":"2022-08-14T12:31:04.882Z","dependency_job_id":null,"html_url":"https://github.com/tupui/batman","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tupui%2Fbatman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tupui%2Fbatman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tupui%2Fbatman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tupui%2Fbatman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tupui","download_url":"https://codeload.github.com/tupui/batman/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245916256,"owners_count":20693389,"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":["bayesian-optimization","optimization","python","sensitivity-analysis","uncertainty"],"created_at":"2024-10-01T12:41:56.435Z","updated_at":"2026-01-07T10:04:01.714Z","avatar_url":"https://github.com/tupui.png","language":"GLSL","funding_links":[],"categories":[],"sub_categories":[],"readme":"|CI|_ |Python|_ |License|_ |Joss|_\r\n\r\n.. |CI| image:: https://circleci.com/gh/tupui/batman.svg?style=svg\r\n.. _CI: https://circleci.com/gh/tupui/batman\r\n\r\n.. |Python| image:: https://img.shields.io/badge/python-3.8-blue.svg\r\n.. _Python: https://python.org\r\n\r\n.. |License| image:: https://img.shields.io/badge/license-BSD_License-blue.svg\r\n.. _License: https://github.com/tupui/batman/blob/master/LICENSE\r\n\r\n.. |Joss| image:: https://joss.theoj.org/papers/a1c4bddc33a1d8ab55fce1a3596196d8/status.svg\r\n.. _Joss: https://joss.theoj.org/papers/a1c4bddc33a1d8ab55fce1a3596196d8\r\n\r\nBatman\r\n======\r\n\r\n**Batman** stands for Bayesian Analysis Tool for Modelling and uncertAinty\r\nquaNtification. It is an open-source Python module.\r\n\r\n*batman* seamlessly allows to do statistical analysis (sensitivity analysis,\r\nUncertainty Quantification, moments) based on non-intrusive ensemble experiment\r\nusing any computer solver. It relies on open source python packages dedicated\r\nto statistics (`OpenTURNS \u003chttp://www.openturns.org\u003e`_ and\r\n`scikit-learn \u003chttp://scikit-learn.org\u003e`_).\r\n\r\nMain features are: \r\n\r\n- Design of Experiment (LHS, low discrepancy sequences, MC),\r\n- Resample the parameter space based on the physic and the sample,\r\n- Surrogate Models (Gaussian process, Polynomial Chaos, RBF, *scikit-learn*'s regressors),\r\n- Optimization (Expected Improvement),\r\n- Sensitivity/Uncertainty Analysis (SA, UA) and Uncertainty Quantification (UQ),\r\n- Visualization in *n*-dimensions (HDR, Kiviat, PDF),\r\n- *POD* for database optimization or data reduction,\r\n- Automatically manage code computations in parallel.\r\n\r\nFull documentation is available at: \r\n\r\n    http://batman.readthedocs.io\r\n\r\n.. inclusion-marker-do-not-remove\r\n\r\nGetting started\r\n===============\r\n\r\nA detailled example can be found in \r\n`tutorial \u003chttp://batman.readthedocs.io/en/latest/tutorial.html\u003e`_. The folder ``test_cases``\r\ncontains examples that you can adapt to you needs. You can find more information\r\nabout the cases within the respectives ``README.rst`` file. \r\n\r\nShoud you be interested by batman's implementation, consider\r\nreading the `technical documentation \u003chttp://batman.readthedocs.io/en/latest/technical.html\u003e`_.\r\n\r\nIf you encounter a bug (or have a feature request), please report it via\r\n`GitLab \u003chttps://github.com/tupui/batman/issues\u003e`_. Or it might be you\r\nfalling but \"Why do we fall sir? So we can learn to pick ourselves up\".\r\n\r\nLast but not least, if you consider contributing check-out\r\n`contributing \u003chttp://batman.readthedocs.io/en/latest/contributing_link.html\u003e`_.\r\n\r\nHappy batman.\r\n\r\nHow to install BATMAN?\r\n----------------------\r\n\r\nThe sources are located on *GitLab*: \r\n\r\n    https://github.com/tupui/batman\r\n\r\nDependencies\r\n............\r\n\r\nThe required dependencies are: \r\n\r\n- `Python \u003chttps://python.org\u003e`_ \u003e= 3.6\r\n- `OpenTURNS \u003chttp://www.openturns.org\u003e`_ \u003e= 1.10\r\n- `scikit-learn \u003chttp://scikit-learn.org\u003e`_ \u003e= 0.18\r\n- `numpy \u003chttp://www.numpy.org\u003e`_ \u003e= 1.13\r\n- `scipy \u003chttp://scipy.org\u003e`_ \u003e= 0.15\r\n- `pathos \u003chttps://github.com/uqfoundation/pathos\u003e`_ \u003e= 0.2\r\n- `matplotlib \u003chttp://matplotlib.org\u003e`_ \u003e= 2.1\r\n- `Paramiko \u003chttp://www.paramiko.org\u003e`_ \u003e= 2.4\r\n- `jsonschema \u003chttp://python-jsonschema.readthedocs.io/en/latest/\u003e`_\r\n\r\nAppart from OpenTURNS, required dependencies are satisfied by the installer.\r\nOptionnal dependencies are: \r\n\r\n- `sphinx \u003chttp://www.sphinx-doc.org\u003e`_ \u003e= 1.4 for documentation\r\n- `ffmpeg \u003chttps://www.ffmpeg.org\u003e`_ for movie visualizations (*n_features* \u003e 2)\r\n\r\nTesting dependencies are: \r\n\r\n- `pytest \u003chttps://docs.pytest.org/en/latest/\u003e`_ \u003e= 2.8\r\n- `mock \u003chttps://pypi.python.org/pypi/mock\u003e`_ \u003e= 2.0\r\n\r\nExtra testing flavours: \r\n\r\n- `coverage \u003chttp://coverage.readthedocs.io\u003e`_ \u003e= 4.4\r\n- `pylint \u003chttps://www.pylint.org\u003e`_ \u003e= 1.6.0\r\n\r\n.. note:: OpenTURNS and ffmpeg are available on *conda* through\r\n    the *conda-forge* channel.\r\n\r\n\r\nFrom sources\r\n............\r\n\r\nUsing the latest python version is prefered! Then to install::\r\n\r\n    git clone git@github.com/tupui/batman.git\r\n    cd batman\r\n    python setup.py install\r\n    python setup.py test\r\n    python setup.py build_sphinx\r\n\r\nThe latter is optionnal as it build the documentation. The testing part is also\r\noptionnal but is recommanded. (\u003c30mins depending on your configuration).\r\n\r\n.. note:: If you don't have install priviledge, add ``--user`` option after install.\r\n    But the simplest way might be to use pip or a conda environment.\r\n\r\nIf batman has been correctly installed, you should be able to call it simply::\r\n\r\n    batman -h\r\n\r\n.. warning:: Depending on your configuration, you might have to export your local path: \r\n    ``export PATH=$PATH:~/.local/bin``. Care to be taken with both your ``PATH``\r\n    and ``PYTHONPATH`` environment variables. Make sure you do not call different\r\n    installation folders. It is recommanded that you leave your ``PYTHONPATH`` empty.\r\n\r\n\r\nHelp and Support\r\n----------------\r\n\r\nAbout us\r\n........\r\n\r\nSee authors and project history at: `about us \u003chttp://batman.readthedocs.io/en/latest/about.html\u003e`_.\r\n\r\nCommunity\r\n.........\r\n\r\nIf you use batman, come and say hi at https://batman-cerfacs.zulipchat.com.\r\nOr send us an email. We would really appreciate that as we keep record of the users!\r\n\r\nCitation\r\n........\r\n\r\nIf you use batman in a scientific publication, we would appreciate `citations \u003chttp://batman.readthedocs.io/en/latest/about.html#citing-batman\u003e`_.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftupui%2Fbatman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftupui%2Fbatman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftupui%2Fbatman/lists"}