diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 6621a33c0ae2bb32f36c0c115ce23ff20bfa6040..5b47057ff8008cb0bcc6d54b6016c6aa74ecb430 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -30,18 +30,27 @@ exitcode-jessie: - coverage run --include=tupak/* -a test/example_tests.py - coverage html - coverage-badge -o coverage_badge.svg -f + + # Make the documentation + - pip install -r docs/requirements.txt + - cd docs + - make html + artifacts: paths: - htmlcov/ - coverage_badge.svg + - docs/_build/html/ pages: stage: deploy dependencies: - exitcode-jessie script: + - mkdir public/ - mv htmlcov/ public/ - mv /builds/Monash/tupak/coverage_badge.svg public/ + - mv docs/_build/html/* public/ artifacts: paths: - public diff --git a/README.md b/README.md index 3fd3060dbd9daab3d4282c8f41685a4eb22970b2..4063c1546ee9a193d8832186f104703602620ca4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ [](https://git.ligo.org/Monash/tupak/commits/master) []( -https://monash.docs.ligo.org/tupak/) +https://monash.docs.ligo.org/tupak/htmlcov/) # Tupak @@ -81,6 +81,6 @@ have also written [a shortened tl;dr here](./TLDR_MULTINEST.md). We have a variety of tests which can be found in the `tests` directory. You can find a [current coverage report for master -here.](https://monash.docs.ligo.org/tupak/). +here.](https://monash.docs.ligo.org/tupak/htmlcov/). diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000000000000000000000000000000000000..c306a28bb26f048732e2945a7042ae3463dee4b0 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = python -msphinx +SPHINXPROJ = tupak +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000000000000000000000000000000000000..153acc8d6e21d4755be021acc653ba5cffae44f6 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,172 @@ +# -*- coding: utf-8 -*- +# +# tupak documentation build configuration file, created by +# sphinx-quickstart on Fri May 25 12:08:01 2018. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('../tupak/')) + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.mathjax', 'numpydoc', + 'nbsphinx'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.txt' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'tupak' +copyright = u'2018, Paul Lasky' +author = u'Paul Lasky' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = u'0.2' +# The full version, including alpha/beta/rc tags. +release = u'0.2' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + 'donate.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'tupakdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'tupak.tex', u'tupak Documentation', + u'Paul Lasky', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'tupak', u'tupak Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'tupak', u'tupak Documentation', + author, 'tupak', 'One line description of project.', + 'Miscellaneous'), +] + + + diff --git a/docs/index.txt b/docs/index.txt new file mode 100644 index 0000000000000000000000000000000000000000..277dc890bf8a758c022d33d6d90e0ba3b2a6131b --- /dev/null +++ b/docs/index.txt @@ -0,0 +1,20 @@ +Welcome to tupak's documentation! +================================= + +.. automodule:: tupak + :members: + +.. toctree:: + :maxdepth: 3 + :caption: Contents: + + likelihood + samplers + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/likelihood.txt b/docs/likelihood.txt new file mode 100644 index 0000000000000000000000000000000000000000..aeb9b1ce8e851acbbc8e871502c1ecbd1fed17f2 --- /dev/null +++ b/docs/likelihood.txt @@ -0,0 +1,30 @@ +========== +Likelihood +========== + +`tupak` likelihood objects are used in calculating the likelihood of the data +for some specific set of parameters. In mathematical notation, the likelihood +can be generically written as :math:`\mathcal{L}(d| \theta)`. How this is +coded up will depend on the problem, but `tupak` expects all likelihood +objects to have a `parameters` attribute (a dictionary of key-value pairs) and +a `log_likelihood()` method. + +The default likelihood we use in the examples is `GravitationalWaveTransient`: + +.. autoclass:: tupak.likelihood.GravitationalWaveTransient + :members: + +We also provide a simpler likelihood + +.. autoclass:: tupak.likelihood.BasicGravitationalWaveTransient + :members: + +We provide an empty parent class which can be subclassed for alternative use +cases + +.. autoclass:: tupak.likelihood.Likelihood + :members: + + + + diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..00dbd07fcd64fd56db393dcea55f539cb2a4eb5e --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,4 @@ +sphinx +numpydoc +nbsphinx +autodoc diff --git a/docs/samplers.txt b/docs/samplers.txt new file mode 100644 index 0000000000000000000000000000000000000000..595c47d1599f57c496ede801c9c5233298351cc6 --- /dev/null +++ b/docs/samplers.txt @@ -0,0 +1,7 @@ +========== +Samplers +========== + +Given a `likelihood` and `prior`, we can run parameter estimation using `run_sampler` + +.. autofunction:: tupak.sampler.run_sampler diff --git a/tupak/__init__.py b/tupak/__init__.py index 0f57bbb4f2261d33feaebeef81f1cface0277a5c..5716af07db5ea5e398f25e36ed030e502905e1f9 100644 --- a/tupak/__init__.py +++ b/tupak/__init__.py @@ -1,3 +1,14 @@ +""" +tupak +===== + +Tupak is The User friendly Parameter estimAtion Kode + +FILL IN THE REST + +""" + + from __future__ import print_function, division # import local files, utils should be imported first