Skip to main content

PyPI version Documentation Status test status DOI

Python ProxMCMC

Installation

Available on pypi

pip install pxmcmc

If installing from source it recommended to use poetry

git clone https://github.com/auggiemarignier/pxmcmc
cd pxmcmc
poetry install
source <ENVIRONMENT_LOCATION>/bin/activate
pytest

Documentation

Full documentation available on readthedocs.

Examples

Examples of how to use this code with sample data are found in the experiments directory. Please start with the earthtopography example, which will quickly run something to get you going!

cd experiments/earthtopography
python main.py --infile ETOPO1_Ice_hpx_256.fits
python plot.py myula_synthesis_<timestamp>.hdf5 .

The phasevel and weaklensing examples replicate the work shown in this paper.

Contributing

Contributions to the package are encouraged! If you wish to contribute, are experiencing problems with the code or need further support, please open an issue to start a discussion. Changes will be integrated via pull requests.

CITATION

If you use this package in your work please cite the following papers

Marignier (2023) PxMCMC: A Python package for proximal Markov Chain Monte Carlo, Journal of Open Source Software, 0(0), 5582. https://doi.org/10.xxxxxx

Marignier et al., Posterior sampling for inverse imaging problems on the sphere in seismology and cosmology, RAS Techniques and Instruments, Volume 2, Issue 1, January 2023, Pages 20–32, https://doi.org/10.1093/rasti/rzac010

Metadata

Release files for pxmcmc 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pxmcmc 1.0.1
File Size Uploaded Provenance Actions
pxmcmc-1.0.1.tar.gz 30.0 kB Without provenance Details for pxmcmc-1.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pxmcmc 1.0.1
File Interpreter ABI Platform Actions
pxmcmc-1.0.1-py3-none-any.whl Python 3 none any Details for pxmcmc-1.0.1-py3-none-any.whl

Total release size: 62.7 kB

Release files / pxmcmc-1.0.1.tar.gz

Download URL pxmcmc-1.0.1.tar.gz
Size 30.0 kB
Tags Source
SHA-256 checksum
How to use checksums
3023e2ded9d41b3925d92b5cb254897c77354ec9401193ef2d5937938b71f790
BLAKE2b-256 checksum
How to use checksums
11e951be996af055135c0bae93ea7e2da61a5224de19fd33f349a39421a46b2b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.11.4 Darwin/22.2.0

Release files / pxmcmc-1.0.1-py3-none-any.whl

Download URL pxmcmc-1.0.1-py3-none-any.whl
Size 32.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
168c748225e2b6be991ce46b5b020b8e65d912a9aecb50007df46adf6a4b9fcc
BLAKE2b-256 checksum
How to use checksums
1e90c52579f071919ebbe65bf8fca991b7c88f31aa8a5e33f818bf95ec513293
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.11.4 Darwin/22.2.0

Security for pxmcmc 1.0.1

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page