Skip to content

Commit

Permalink
Docs2 (#147)
Browse files Browse the repository at this point in the history
* refactoring docs

* rtds version

* invalid key

* adding tutorial for arviz

* front page

* removing old index
  • Loading branch information
dfm committed Mar 7, 2021
1 parent 21647ea commit f6a73bc
Show file tree
Hide file tree
Showing 3 changed files with 69 additions and 85 deletions.
1 change: 0 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
"sphinx.ext.napoleon",
"myst_nb",
]
source_suffix = ".rst"
master_doc = "index"

# General information about the project.
Expand Down
69 changes: 69 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# corner.py

_Make some beautiful corner plots._

```{admonition} Corner plot /ˈkôrnər plät/ (noun):
:class: tip
An illustrative representation of different projections of samples in
high dimensional spaces. It is awesome. I promise.
_Synonyms: scatterplot matrix, pairs plot, draftsman's display_
```

This Python module uses [matplotlib](https://matplotlib.org/) to visualize
multidimensional samples using a scatterplot matrix.
In these visualizations, each one- and two-dimensional projection of the
sample is plotted to reveal covariances.
_corner_ was originally conceived to display the results of Markov Chain
Monte Carlo simulations and the defaults are chosen with this application in
mind but it can be used for displaying many qualitatively different samples.

Development of _corner_ happens [on GitHub](https://github.com/dfm/corner.py) so you can [raise any issues you have there](https://github.com/dfm/corner.py/issues).
_corner_ has been used extensively in the astronomical literature and it [has occasionally been cited](https://ui.adsabs.harvard.edu/abs/2016JOSS....1...24F/citations)
as `corner.py` or using its previous name `triangle.py`.

[![Tests](https://github.com/dfm/corner.py/workflows/Tests/badge.svg?style=flat)](https://github.com/dfm/corner.py/actions)
[![License](https://img.shields.io/badge/license-BSD-blue.svg?style=flat)](https://github.com/dfm/corner.py/blob/main/LICENSE)
[![DOI](https://zenodo.org/badge/4729/dfm/corner.py.svg?style=flat)](https://zenodo.org/badge/latestdoi/4729/dfm/corner.py)
[![Paper](https://joss.theoj.org/papers/10.21105/joss.00024/status.svg?style=flat)](http://dx.doi.org/10.21105/joss.00024)

## Documentation

```{toctree}
:maxdepth: 2
install
pages/quickstart
pages/sigmas
pages/custom
pages/arviz
api
```

## Attribution

If you make use of this code, please cite [the JOSS paper](https://dx.doi.org/10.21105/joss.00024):

```tex
@article{corner,
doi = {10.21105/joss.00024},
url = {https://doi.org/10.21105/joss.00024},
year = {2016},
month = {jun},
publisher = {The Open Journal},
volume = {1},
number = {2},
pages = {24},
author = {Daniel Foreman-Mackey},
title = {corner.py: Scatterplot matrices in Python},
journal = {The Journal of Open Source Software}
}
```

## Authors & License

Copyright 2013-2021 Dan Foreman-Mackey

Built by [Dan Foreman-Mackey](https://github.com/dfm) and contributors (see
[the contribution graph](https://github.com/dfm/corner.py/graphs/contributors) for the most
up to date list). Licensed under the 2-clause BSD license (see `LICENSE`).
84 changes: 0 additions & 84 deletions docs/index.rst

This file was deleted.

0 comments on commit f6a73bc

Please sign in to comment.