corner 2.2.2__tar.gz → 2.2.3__tar.gz

corner-2.2.3/.copier-answers.yml

@@ -0,0 +1,28 @@
+_commit: v0.0.14
+_src_path: gh:dfm/copier-python
+author_email: foreman.mackey@gmail.com
+author_fullname: Dan Foreman-Mackey
+author_username: dfm
+code_of_conduct_email: foreman.mackey@gmail.com
+copyright_holder: Dan Foreman-Mackey
+copyright_license: BSD
+copyright_year: 2013-2022
+documentation_url: https://corner.readthedocs.io
+enable_mypy: false
+enable_pybind11: false
+enable_windows: false
+general_nox_sessions: '"lint"'
+project_description: Make some beautiful corner plots
+project_development_status: stable
+project_line_length: 79
+project_name: corner.py
+python_formal_min_version: 6
+python_max_version: 10
+python_min_version: 7
+python_nox_sessions: '"tests"'
+python_package_distribution_name: corner
+python_package_import_name: corner
+readthedocs_project_name: corner
+repository_name: corner.py
+repository_namespace: dfm
+

corner-2.2.3/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

{corner-2.2.2 → corner-2.2.3}/.github/workflows/tests.yml

@@ -15,29 +15,26 @@ jobs:
       fail-fast: false
       matrix:
         os: ["ubuntu-latest"]
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ["3.10", "3.11", "3.12"]
         nox-session: ["tests"]
         include:
-          - os: macos-latest
-            python-version: "3.10"
-            nox-session: "tests"
           - os: ubuntu-latest
             python-version: "3.10"
             nox-session: "lint"
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: true
           fetch-depth: 0
       - name: Configure Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Cache pre-commit environments
         if: ${{ matrix.nox-session == 'lint' }}
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.cache/pre-commit
           key: ${{ runner.os }}-pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
@@ -50,7 +47,7 @@ jobs:
       - name: Run tests
         run: python -m nox --non-interactive -s ${{ matrix.nox-session }}
       - name: Upload generated images on failure
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         if: ${{ failure() && matrix.nox-session == 'tests' }}
         with:
           name: images-${{ matrix.os }}-${{ matrix.python-version }}
@@ -59,10 +56,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         name: Install Python
         with:
           python-version: "3.10"
@@ -71,7 +68,7 @@ jobs:
           python -m pip install -U pip
           python -m pip install -U build
           python -m build .
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           path: dist/*
 
@@ -80,12 +77,12 @@ jobs:
     runs-on: ubuntu-latest
     if: startsWith(github.ref, 'refs/tags/')
     steps:
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: artifact
           path: dist
 
-      - uses: pypa/gh-action-pypi-publish@v1.8.4
+      - uses: pypa/gh-action-pypi-publish@v1.11.0
         with:
           user: __token__
           password: ${{ secrets.pypi_password }}

{corner-2.2.2 → corner-2.2.3}/.pre-commit-config.yaml

@@ -7,7 +7,7 @@ repos:
         language: fail
         files: "\\.rej$"
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v5.0.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
@@ -15,15 +15,15 @@ repos:
         exclude: ".copier-answers.yml"
       - id: check-yaml
   - repo: https://github.com/PyCQA/isort
-    rev: "5.12.0"
+    rev: "5.13.2"
     hooks:
       - id: isort
         additional_dependencies: [toml]
   - repo: https://github.com/psf/black
-    rev: "23.3.0"
+    rev: "24.10.0"
     hooks:
       - id: black-jupyter
   - repo: https://github.com/kynan/nbstripout
-    rev: "0.6.1"
+    rev: "0.8.1"
     hooks:
       - id: nbstripout

{corner-2.2.2/src/corner.egg-info → corner-2.2.3}/PKG-INFO

@@ -1,22 +1,32 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: corner
-Version: 2.2.2
+Version: 2.2.3
 Summary: Make some beautiful corner plots
-Author-email: Dan Foreman-Mackey <foreman.mackey@gmail.com>
-License: BSD 2-Clause License
 Project-URL: Homepage, https://corner.readthedocs.io
 Project-URL: Source, https://github.com/dfm/corner.py
 Project-URL: Bug Tracker, https://github.com/dfm/corner.py/issues
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
+Author-email: Dan Foreman-Mackey <foreman.mackey@gmail.com>
+License: BSD 2-Clause License
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-Provides-Extra: test
+Requires-Dist: matplotlib>=2.1
 Provides-Extra: arviz
+Requires-Dist: arviz>=0.9; extra == 'arviz'
 Provides-Extra: docs
-License-File: LICENSE
+Requires-Dist: arviz>=0.9; extra == 'docs'
+Requires-Dist: ipython; extra == 'docs'
+Requires-Dist: myst-nb; extra == 'docs'
+Requires-Dist: pandoc; extra == 'docs'
+Requires-Dist: sphinx-book-theme; extra == 'docs'
+Requires-Dist: sphinx>=1.7.5; extra == 'docs'
+Provides-Extra: test
+Requires-Dist: arviz>=0.9; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: scipy; extra == 'test'
+Description-Content-Type: text/markdown
 
 # corner.py
 

corner-2.2.3/demo.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python
+
+
+import numpy as np
+from matplotlib import rcParams
+
+import corner
+
+rcParams["font.size"] = 16
+rcParams["font.family"] = "sans-serif"
+rcParams["font.sans-serif"] = ["Computer Modern Sans"]
+rcParams["text.usetex"] = True
+rcParams["text.latex.preamble"] = r"\usepackage{cmbright}"
+
+np.random.seed(42)
+
+# Set up the parameters of the problem.
+ndim, nsamples = 3, 50000
+
+# Generate some fake data.
+data1 = np.random.randn(ndim * 4 * nsamples / 5).reshape(
+    [4 * nsamples / 5, ndim]
+)
+data2 = 4 * np.random.rand(ndim)[None, :] + np.random.randn(
+    ndim * nsamples / 5
+).reshape([nsamples / 5, ndim])
+data = np.vstack([data1, data2])
+
+# Plot it.
+figure = corner.corner(
+    data,
+    labels=[
+        r"$x$",
+        r"$y$",
+        r"$\log \alpha$",
+        r"$\Gamma \, [\mathrm{parsec}]$",
+    ],
+    quantiles=[0.16, 0.5, 0.84],
+    show_titles=True,
+    title_kwargs={"fontsize": 12},
+)
+figure.gca().annotate(
+    "a demo corner plot",
+    xy=(1.0, 1.0),
+    xycoords="figure fraction",
+    xytext=(-20, -10),
+    textcoords="offset points",
+    ha="right",
+    va="top",
+)
+figure.savefig("demo.png", dpi=300)

corner-2.2.3/docs/.gitignore

@@ -0,0 +1,5 @@
+_*
+!_static
+!*.png
+modules
+examples

corner-2.2.3/docs/Makefile

@@ -0,0 +1,231 @@
+# Makefile for Sphinx documentation
+
+default: dirhtml
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+	$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don\'t have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  applehelp  to make an Apple Help Book"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  epub3      to make an epub3"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  coverage   to run coverage check of the documentation (if enabled)"
+	@echo "  dummy      to check syntax errors of document sources"
+
+.PHONY: clean
+clean:
+	rm -rf $(BUILDDIR)/* $(PAGES)
+
+.PHONY: html
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+.PHONY: dirhtml
+dirhtml: $(PAGES)
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+.PHONY: singlehtml
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+.PHONY: pickle
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+.PHONY: json
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+.PHONY: htmlhelp
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+.PHONY: qthelp
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/cornerpy.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/cornerpy.qhc"
+
+.PHONY: applehelp
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
+.PHONY: devhelp
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/cornerpy"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/cornerpy"
+	@echo "# devhelp"
+
+.PHONY: epub
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+.PHONY: epub3
+epub3:
+	$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
+	@echo
+	@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
+
+.PHONY: latex
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+.PHONY: latexpdf
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+.PHONY: latexpdfja
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+.PHONY: text
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+.PHONY: man
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+.PHONY: texinfo
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+.PHONY: info
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+.PHONY: gettext
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+.PHONY: changes
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+.PHONY: linkcheck
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+.PHONY: doctest
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+.PHONY: coverage
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+.PHONY: xml
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+.PHONY: pseudoxml
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+
+.PHONY: dummy
+dummy:
+	$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
+	@echo
+	@echo "Build finished. Dummy builder generates no files."

corner-2.2.3/docs/api.rst

@@ -0,0 +1,14 @@
+.. module:: corner
+
+Detailed API documentation
+==========================
+
+The main user-facing function is :func:`corner.corner` but the lower level
+functions :func:`corner.hist2d` and :func:`corner.quantile` are also
+documented here.
+
+.. autofunction:: corner.corner
+.. autofunction:: corner.hist2d
+.. autofunction:: corner.quantile
+.. autofunction:: corner.overplot_lines
+.. autofunction:: corner.overplot_points

corner-2.2.3/docs/conf.py

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+
+import corner
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.napoleon",
+    "myst_nb",
+    "IPython.sphinxext.ipython_console_highlighting",
+]
+master_doc = "index"
+
+# General information about the project.
+project = "corner.py"
+copyright = "2013-2021 Dan Foreman-Mackey & contributors"
+
+version = corner.__version__
+release = corner.__version__
+
+exclude_patterns = ["_build"]
+html_theme = "sphinx_book_theme"
+html_title = "corner.py"
+html_static_path = ["_static"]
+html_show_sourcelink = False
+html_theme_options = {
+    "path_to_docs": "docs",
+    "repository_url": "https://github.com/dfm/corner.py",
+    "repository_branch": "main",
+    "launch_buttons": {
+        "binderhub_url": "https://mybinder.org",
+        "colab_url": "https://colab.research.google.com/",
+        "notebook_interface": "jupyterlab",
+    },
+    "use_edit_page_button": True,
+    "use_issues_button": True,
+    "use_repository_button": True,
+    "use_download_button": True,
+}
+html_baseurl = "https://corner.readthedocs.io/en/latest/"
+nb_execution_mode = "force"
+
+# download notebooks as .ipynb and not as .ipynb.txt
+html_sourcelink_suffix = ""

corner-2.2.3/docs/index.md

@@ -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`).

corner-2.2.3/docs/install.rst

@@ -0,0 +1,58 @@
+.. _install:
+
+Installation
+============
+
+Dependencies
+------------
+
+corner.py depends on ``matplotlib``, ``numpy``, and optionally ``scipy``. You
+can install these using your favorite Python package manager and I would
+recommend `conda <http://conda.pydata.org/docs/>`_ if you don't already have
+an opinion.
+
+Using pip
+---------
+
+The easiest way to install the most recent stable version of ``corner`` is
+with `pip <http://www.pip-installer.org/>`_:
+
+.. code-block:: bash
+
+    python -m pip install corner
+
+
+From source
+-----------
+
+Alternatively, you can get the source by downloading a `tarball
+<https://github.com/dfm/corner.py/tarball/master>`_ or cloning `the git
+repository <https://github.com/dfm/corner.py>`_:
+
+.. code-block:: bash
+
+    git clone https://github.com/dfm/corner.py.git
+
+Once you've downloaded the source, you can navigate into the root source
+directory and run:
+
+.. code-block:: bash
+
+    python -m pip install .
+
+
+Tests
+-----
+
+If you installed from source, you can run the unit tests, but know that
+plotting-based tests can be pretty brittle. From the root of the
+source directory, run:
+
+.. code-block:: bash
+
+    python -m pip install nox
+    python -m nox -s tests-PYTHON_VERSION
+
+Where ``PYTHON_VERSION`` is the version of Python you're using (e.g.
+``3.10``) This might take a few minutes but you shouldn't get any errors
+if all went as planned.