From 031b048fa32bcaf2981172cd5b767bcbe9b6c53e Mon Sep 17 00:00:00 2001 From: Fabian Joswig Date: Sat, 11 Mar 2023 21:35:34 +0000 Subject: [PATCH 1/4] build: bug report default title changed. --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 355d9e4e..dd47810a 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,6 +1,6 @@ name: Bug report description: Report a bug. -title: "BUG:" +title: "" labels: [bug] body: From a1d6b95e9af17c8756a90730410211dd5b801d89 Mon Sep 17 00:00:00 2001 From: Fabian Joswig Date: Sat, 11 Mar 2023 21:38:29 +0000 Subject: [PATCH 2/4] build: bug report default title changed again. --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index dd47810a..547f7b81 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,6 +1,6 @@ name: Bug report description: Report a bug. -title: "" +title: "" labels: [bug] body: From 34981b6102d4cd8af74f5bdf3cae7b992634041c Mon Sep 17 00:00:00 2001 From: Fabian Joswig Date: Mon, 13 Mar 2023 13:25:24 +0000 Subject: [PATCH 3/4] docs: conda-forge installation added to README. --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bc9bcef1..50f388b6 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,17 @@ - **Bug reports:** https://github.com/fjosw/pyerrors/issues ## Installation -To install the most recent release (via [pypi](https://pypi.org/project/pyerrors/)) run +Install the most recent release using pip and [pypi](https://pypi.org/project/pyerrors/): ```bash pip install pyerrors # Fresh install -pip install -U pyerrors # Upgrade +pip install -U pyerrors # Update ``` -to install the current `develop` version run +Install the most recent release using conda and [conda-forge](https://anaconda.org/conda-forge/pyerrors): +```bash +conda install -c conda-forge pyerrors # Fresh install +conda update -c conda-forge pyerrors # Update +``` +Install the current `develop` version: ```bash pip install git+https://github.com/fjosw/pyerrors.git@develop ``` From a2a64146b0483235e23b1791a04a55a53e397737 Mon Sep 17 00:00:00 2001 From: Fabian Joswig Date: Mon, 13 Mar 2023 13:27:57 +0000 Subject: [PATCH 4/4] docs: installation info also added to start page of the documentation. --- pyerrors/__init__.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/pyerrors/__init__.py b/pyerrors/__init__.py index b82eb7f8..a692023c 100644 --- a/pyerrors/__init__.py +++ b/pyerrors/__init__.py @@ -23,6 +23,19 @@ where applicable. There exist similar publicly available implementations of gamma method error analysis suites in [Fortran](https://gitlab.ift.uam-csic.es/alberto/aderrors), [Julia](https://gitlab.ift.uam-csic.es/alberto/aderrors.jl) and [Python](https://github.com/mbruno46/pyobs). +## Installation + +Install the most recent release using pip and [pypi](https://pypi.org/project/pyerrors/): +```bash +pip install pyerrors # Fresh install +pip install -U pyerrors # Update +``` +Install the most recent release using conda and [conda-forge](https://anaconda.org/conda-forge/pyerrors): +```bash +conda install -c conda-forge pyerrors # Fresh install +conda update -c conda-forge pyerrors # Update +``` + ## Basic example ```python