<!--
SPDX-FileCopyrightText: 2024 Shell Global Solutions International B.V. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0
-->
<div align="center">
[](https://pypi.org/project/openmcmc/)
[](https://pypi.org/project/openmcmc/)
[](https://opensource.org/licenses/Apache-2.0)
[](https://github.com/psf/black)
[](https://github.com/sede-open/openMCMC/actions/workflows/main.yml)
[](https://sonarcloud.io/summary/new_code?id=pyelq_openmcmc)
[](https://sonarcloud.io/summary/new_code?id=pyelq_openmcmc)
[](https://sonarcloud.io/summary/new_code?id=pyelq_openmcmc)
[](https://sonarcloud.io/summary/new_code?id=pyelq_openmcmc)
[](https://sonarcloud.io/summary/new_code?id=pyelq_openmcmc)
[](https://sonarcloud.io/summary/new_code?id=pyelq_openmcmc)
[](https://sonarcloud.io/summary/new_code?id=pyelq_openmcmc)
[](https://sonarcloud.io/summary/new_code?id=pyelq_openmcmc)
</div>
# openMCMC
openMCMC is a package for constructing Bayesian models from distributional components, and then doing parameter
estimation using Markov Chain Monte Carlo (MCMC) methods. The package supports a number of standard distributions used
in Bayesian modelling (e.g. Normal, gamma, uniform), and a number of simple functional forms for the parameters of
these distributions. For a model constructed in the toolbox, a number of different MCMC algorithms are available,
including simple random walk Metropolis-Hastings, manifold MALA, exact samplers for conjugate distribution choices,
and reversible-jump MCMC for parameters with an unknown dimensionality.
***
# Installing openMCMC as a package
Suppose you want to use this openMCMC package in a different project.
You can install it from [PyPi](https://pypi.org/project/openmcmc/) through pip
`pip install openmcmc`.
Or you could clone the repository and install it from the source code. After activating the environment you want to
install openMCMC in, open a terminal, move to the main openMCMC folder
where pyproject.toml is located and run `pip install .`, optionally you can pass the `-e` flag is for editable mode.
All the main options, info and settings for the package are found in the pyproject.toml file which sits in this repo
as well.
***
# Examples
For some examples on how to use this package please check out these [Examples](https://github.com/sede-open/openMCMC/blob/main/examples)
***
# Contribution
This project welcomes contributions and suggestions. If you have a suggestion that would make this better you can
simply open an issue with a relevant title. Don't forget to give the project a star! Thanks again!
For more details on contributing to this repository, see the [Contributing guide](https://github.com/sede-open/openMCMC/blob/main/CONTRIBUTING.md).
***
# Licensing
Distributed under the Apache License Version 2.0. See the [license file](https://github.com/sede-open/openMCMC/blob/main/LICENSE.md) for more information.
Raw data
{
"_id": null,
"home_page": "https://sede-open.github.io/openMCMC/",
"name": "openmcmc",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<3.12",
"maintainer_email": "",
"keywords": "Markov Chain Monte Carlo,MCMC",
"author": "Bas van de Kerkhof",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/0b/3f/655adbd2914412357f261298c1e48b6821463e1358ec1cb127882b4d51ba/openmcmc-1.0.4.tar.gz",
"platform": null,
"description": "<!--\nSPDX-FileCopyrightText: 2024 Shell Global Solutions International B.V. All Rights Reserved.\n\nSPDX-License-Identifier: Apache-2.0\n-->\n\n<div align=\"center\">\n\n[](https://pypi.org/project/openmcmc/)\n[](https://pypi.org/project/openmcmc/)\n[](https://opensource.org/licenses/Apache-2.0)\n[](https://github.com/psf/black)\n[](https://github.com/sede-open/openMCMC/actions/workflows/main.yml)\n\n[](https://sonarcloud.io/summary/new_code?id=pyelq_openmcmc)\n[](https://sonarcloud.io/summary/new_code?id=pyelq_openmcmc)\n[](https://sonarcloud.io/summary/new_code?id=pyelq_openmcmc)\n[](https://sonarcloud.io/summary/new_code?id=pyelq_openmcmc)\n[](https://sonarcloud.io/summary/new_code?id=pyelq_openmcmc)\n[](https://sonarcloud.io/summary/new_code?id=pyelq_openmcmc)\n[](https://sonarcloud.io/summary/new_code?id=pyelq_openmcmc)\n[](https://sonarcloud.io/summary/new_code?id=pyelq_openmcmc)\n</div>\n\n# openMCMC\nopenMCMC is a package for constructing Bayesian models from distributional components, and then doing parameter \nestimation using Markov Chain Monte Carlo (MCMC) methods. The package supports a number of standard distributions used \nin Bayesian modelling (e.g. Normal, gamma, uniform), and a number of simple functional forms for the parameters of \nthese distributions. For a model constructed in the toolbox, a number of different MCMC algorithms are available, \nincluding simple random walk Metropolis-Hastings, manifold MALA, exact samplers for conjugate distribution choices, \nand reversible-jump MCMC for parameters with an unknown dimensionality.\n***\n\n# Installing openMCMC as a package\nSuppose you want to use this openMCMC package in a different project.\nYou can install it from [PyPi](https://pypi.org/project/openmcmc/) through pip \n`pip install openmcmc`.\nOr you could clone the repository and install it from the source code. After activating the environment you want to \ninstall openMCMC in, open a terminal, move to the main openMCMC folder\nwhere pyproject.toml is located and run `pip install .`, optionally you can pass the `-e` flag is for editable mode.\nAll the main options, info and settings for the package are found in the pyproject.toml file which sits in this repo\nas well.\n\n***\n\n# Examples\nFor some examples on how to use this package please check out these [Examples](https://github.com/sede-open/openMCMC/blob/main/examples)\n\n***\n# Contribution\nThis project welcomes contributions and suggestions. If you have a suggestion that would make this better you can \nsimply open an issue with a relevant title. Don't forget to give the project a star! Thanks again!\n\nFor more details on contributing to this repository, see the [Contributing guide](https://github.com/sede-open/openMCMC/blob/main/CONTRIBUTING.md).\n\n***\n# Licensing\n\nDistributed under the Apache License Version 2.0. See the [license file](https://github.com/sede-open/openMCMC/blob/main/LICENSE.md) for more information.\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "openMCMC tools",
"version": "1.0.4",
"project_urls": {
"Documentation": "https://sede-open.github.io/openMCMC/",
"Homepage": "https://sede-open.github.io/openMCMC/",
"Repository": "https://github.com/sede-open/openMCMC"
},
"split_keywords": [
"markov chain monte carlo",
"mcmc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a553303c50e9914ebd14a886ffa66b4bd1fca438c0c906971f87095b663d2904",
"md5": "8315e73e7f49096ada96dedf30452e9e",
"sha256": "9007558a86f9c5e005030a294b48c70903d466cb0960c5a97af455e210f6938b"
},
"downloads": -1,
"filename": "openmcmc-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8315e73e7f49096ada96dedf30452e9e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<3.12",
"size": 44664,
"upload_time": "2024-03-13T10:26:18",
"upload_time_iso_8601": "2024-03-13T10:26:18.853978Z",
"url": "https://files.pythonhosted.org/packages/a5/53/303c50e9914ebd14a886ffa66b4bd1fca438c0c906971f87095b663d2904/openmcmc-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0b3f655adbd2914412357f261298c1e48b6821463e1358ec1cb127882b4d51ba",
"md5": "755517a4cc7e11522c07a00bb06c0c35",
"sha256": "923eab8ab996e23a0e7b345cc35641682c7e497c6981f37b2631158a7d88aafc"
},
"downloads": -1,
"filename": "openmcmc-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "755517a4cc7e11522c07a00bb06c0c35",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<3.12",
"size": 35218,
"upload_time": "2024-03-13T10:26:20",
"upload_time_iso_8601": "2024-03-13T10:26:20.051265Z",
"url": "https://files.pythonhosted.org/packages/0b/3f/655adbd2914412357f261298c1e48b6821463e1358ec1cb127882b4d51ba/openmcmc-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-13 10:26:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sede-open",
"github_project": "openMCMC",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "openmcmc"
}
JSON
