/pymcmcstat_examples

Primary LanguageJupyter NotebookMIT LicenseMIT

Tutorials for Python Package pymcmcstat

These tutorials are designed to accompany the Python package pymcmcstat. The "index.ipynb" file is a good place to start in order to figure out what each tutorial has to offer.

To work interactively with the example notebooks, launch them with Binder!

binder

URL: https://mybinder.org/v2/gh/prmiles/pymcmcstat_examples/master

Otherwise, view the tutorials with Jupyter nbviewer:

nbviewer

URL: https://nbviewer.jupyter.org/github/prmiles/pymcmcstat_examples/blob/master/index.ipynb

Additional Resources

Feel free to checkout the documentation for pymcmcstat on ReadTheDocs.

docs

Local Use

Feel free to download the repository! We recommend you use a virtual environment for running these examples. Anaconda provides a nice interface for managing environments and installing Jupyter Notebooks. Open a terminal for your environment, navigate to the downloaded repository and execute

$ pip install -r requirements.txt

This will install all (or at least most) of the required packages for running these examples. Obviously, to run the notebooks locally, you will also need to install Jupyter Notebooks.

Feedback

If you have any issues running one of the examples, feel free to submit an issue. If you have any examples that you think would be worth adding to the collection, feel free to suggest them as a feature request or submit them by following the contribution guidelines.