Getting Started =============== .. toctree:: :hidden: Prerequisites ------------- ``bayesim`` has been most thoroughly tested in Python 3.6. Download -------- To install bayesim simply type .. code-block:: shell pip install bayesim -r https://raw.githubusercontent.com/PV-Lab/bayesim/master/requirements.txt (the extra flag is to make sure you get the version of ``deepdish`` that works) Usage ----- For more details on both usage methods described below, see the :doc:`manual`. Python / Jupyter ^^^^^^^^^^^^^^^^ The easiest way to learn how ``bayesim`` works is by stepping through one of the :doc:`Examples `, which have well-commented `Jupyter notebooks `_ associated with them and can be run in `binder `_ with no need to install Python, ``bayesim``, or any of its dependencies locally. If you are comfortable coding in Python, these examples will also make it clear how to script using ``bayesim``. Command line ^^^^^^^^^^^^ A command line interface will be implemented in a future release!