Skip to content

Commit

Permalink
improving docs
Browse files Browse the repository at this point in the history
  • Loading branch information
arm61 committed Feb 25, 2020
1 parent 6072742 commit 53673bf
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 14 deletions.
12 changes: 5 additions & 7 deletions uravu/_fig_params.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
"""
Figure parameters for kinisi to help make nice plots.
Copyright (c) Andrew R. McCluskey and Benjamin J. Morgan
Distributed under the terms of the MIT License
@author: Andrew R. McCluskey
Figure parameters for uravu to help make nice plots.
"""

# Copyright (c) Andrew R. McCluskey
# Distributed under the terms of the MIT License
# author: Andrew R. McCluskey

from collections import OrderedDict
from matplotlib import rcParams, cycler

Expand Down
7 changes: 6 additions & 1 deletion uravu/plotting.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
"""
Plotting functions
These are plotting functions that take either :class:`Relationship`
or :class:`Distribution` class objects.
The aim is to produce *publication quality* plots. However, we
recognise that taste exists, and ours may be different from yours.
The colorscheme in this work was chosen to be colorblind friendly.
"""

# Copyright (c) Andrew R. McCluskey
Expand Down
10 changes: 5 additions & 5 deletions uravu/sampling.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
"""
This is the Relationship class, which allows for the storage and manipulation
of analytical relationships between and abscissa and ordinate.
The :mod:`sampling` module implements the use of a generalised
MCMC (using `emcee`_) and nested sampling (using `dynesty`_) for the
:class:`Relationship` objects.
This enables the determination of maximum likelihood, the evalulation of
posterior probability distributions by Markov chain Monte-Carlo (MCMC) and
the determination of Bayesian evidence using nested sampling.
.. _emcee: https://emcee.readthedocs.io/
.. _dynesty: https://dynesty.readthedocs.io/
"""

# Copyright (c) Andrew R. McCluskey
Expand Down
3 changes: 2 additions & 1 deletion uravu/utils.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
"""
Some utility functions for the uravu package.
A few additional utility functions to improve the usability of
``uravu``.
"""

# Copyright (c) Andrew R. McCluskey
Expand Down

0 comments on commit 53673bf

Please sign in to comment.