Metadata-Version: 2.1
Name: cmdstanpy
Version: 0.9.75
Summary: Python interface to CmdStan
Home-page: https://github.com/stan-dev/cmdstanpy
Author: Stan Dev Team
License: UNKNOWN
Description: # CmdStanPy
        
        [![codecov](https://codecov.io/gh/stan-dev/cmdstanpy/branch/master/graph/badge.svg)](https://codecov.io/gh/stan-dev/cmdstanpy)
        
        
        CmdStanPy is a lightweight pure-Python interface to CmdStan which provides access to the Stan compiler and all inference algorithms.  It supports both development and production workflows. Because model development and testing may require many iterations, the defaults favor development mode and therefore output files are stored on a temporary filesystem. Non-default options allow all aspects of a run to be specified so that scripts can be used to distributed analysis jobs across nodes and machines.
        
        CmdStanPy is distributed via PyPi: https://pypi.org/project/cmdstanpy/
        
        ### Goals
        
        - Clean interface to Stan services so that CmdStanPy can keep up with Stan releases.
        
        - Provide access to all CmdStan inference methods.
        
        - Easy to install,
          + minimal Python library dependencies: numpy, pandas
          + Python code doesn't interface directly with c++, only calls compiled executables
        
        - Modular - CmdStanPy produces a MCMC sample (or point estimate) from the posterior; other packages do analysis and visualization.
        
        - Low memory overhead - by default, minimal memory used above that required by CmdStanPy; objects run CmdStan programs and track CmdStan input and output files.
        
        
        ### Source Repository
        
        CmdStanPy and CmdStan are available from GitHub: https://github.com/stan-dev/cmdstanpy and https://github.com/stan-dev/cmdstan
        
        
        ### Docs
        
        The latest release documentation is hosted on  https://mc-stan.org/cmdstanpy, older release versions are available from readthedocs:  https://cmdstanpy.readthedocs.io
        
        ### Licensing
        
        The CmdStanPy, CmdStan, and the core Stan C++ code are licensed under new BSD.
        
        ### Example
        
        ::
        
            import os
            from cmdstanpy import cmdstan_path, CmdStanModel
        
            # specify locations of Stan program file and data
            bernoulli_stan = os.path.join(cmdstan_path(), 'examples', 'bernoulli', 'bernoulli.stan')
            bernoulli_data = os.path.join(cmdstan_path(), 'examples', 'bernoulli', 'bernoulli.data.json')
        
            # instantiate a model; compiles the Stan program by default
            bernoulli_model = CmdStanModel(stan_file=bernoulli_stan)
        
            # obtain a posterior sample from the model conditioned on the data
            bernoulli_fit = bernoulli_model.sample(chains=4, data=bernoulli_data)
        
            # summarize the results (wraps CmdStan `bin/stansummary`):
            bernoulli_fit.summary()
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Description-Content-Type: text/markdown
Provides-Extra: all
Provides-Extra: tests
Provides-Extra: docs
