Skip to content

Commit 593de60

Browse files
[MRG] Add Conda install documentation and update issue templates (#444)
* Add Conda install documentation * Try drop down? * Add render shell back * Clean up question.yml
1 parent 38755d3 commit 593de60

File tree

4 files changed

+63
-9
lines changed

4 files changed

+63
-9
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

+15-3
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,30 @@ body:
2424
id: versions
2525
attributes:
2626
label: Versions
27-
placeholder: |
28-
Please run the following snippet and paste the output here.
27+
description: |
28+
<details closed><summary>Instructions to get necessary versions</summary>
29+
<p>
30+
31+
Please run the following snippet and paste the output below.
32+
33+
```python
2934
import pmdarima; pmdarima.show_versions()
3035
31-
For pmdarima versions <1.5.2 use this:
36+
# For pmdarima versions <1.5.2 use this:
3237
import platform; print(platform.platform())
3338
import sys; print("Python", sys.version)
3439
import pmdarima; print("pmdarima", pmdarima.__version__)
3540
import numpy; print("NumPy", numpy.__version__)
3641
import scipy; print("SciPy", scipy.__version__)
3742
import sklearn; print("Scikit-Learn", sklearn.__version__)
3843
import statsmodels; print("Statsmodels", statsmodels.__version__)
44+
```
45+
46+
</p>
47+
</details
48+
placeholder: |
49+
See drop down above for instructions on retrieving the versions necessary for debugging. These will be
50+
automatically converted to code, so no need for back ticks
3951
render: shell
4052
validations:
4153
required: true

.github/ISSUE_TEMPLATE/question.yml

+17-5
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ body:
88
Before asking a question, please consult our closed issues and docs to see
99
if we have already addressed it:
1010
11-
https://github.com/alkaline-ml/pmdarima/issues?q=is%3Aissue+is%3Aclosed
12-
https://www.alkaline-ml.com/pmdarima/
11+
- [Closed Issues](https://github.com/alkaline-ml/pmdarima/issues?q=is%3Aissue+is%3Aclosed)
12+
- [Documentation](https://www.alkaline-ml.com/pmdarima/)
1313
- type: textarea
1414
id: question
1515
attributes:
@@ -21,18 +21,30 @@ body:
2121
id: versions
2222
attributes:
2323
label: Versions (if necessary)
24-
placeholder: |
25-
Please run the following snippet and paste the output here.
24+
description: |
25+
<details closed><summary>Instructions to get necessary versions</summary>
26+
<p>
27+
28+
Please run the following snippet and paste the output below.
29+
30+
```python
2631
import pmdarima; pmdarima.show_versions()
2732
28-
For pmdarima versions <1.5.2 use this:
33+
# For pmdarima versions <1.5.2 use this:
2934
import platform; print(platform.platform())
3035
import sys; print("Python", sys.version)
3136
import pmdarima; print("pmdarima", pmdarima.__version__)
3237
import numpy; print("NumPy", numpy.__version__)
3338
import scipy; print("SciPy", scipy.__version__)
3439
import sklearn; print("Scikit-Learn", sklearn.__version__)
3540
import statsmodels; print("Statsmodels", statsmodels.__version__)
41+
```
42+
43+
</p>
44+
</details
45+
placeholder: |
46+
See drop down above for instructions on retrieving the versions necessary for answering your question. These
47+
will be automatically converted to code, so no need for back ticks
3648
render: shell
3749
validations:
3850
required: false

README.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,28 @@ from a scikit-learn background.
2626

2727
## Installation
2828

29+
### pip
30+
2931
Pmdarima has binary and source distributions for Windows, Mac and Linux (`manylinux`) on pypi
3032
under the package name `pmdarima` and can be downloaded via `pip`:
3133

3234
```bash
33-
$ pip install pmdarima
35+
pip install pmdarima
3436
```
3537

38+
### conda
39+
40+
Pmdarima also has Mac and Linux builds available via `conda` and can be installed like so:
41+
42+
```bash
43+
conda config --add channels conda-forge
44+
conda config --set channel_priority strict
45+
conda install pmdarima
46+
```
47+
48+
**Note:** We do not maintain our own Conda binaries, they are maintained at https://github.com/conda-forge/pmdarima-feedstock.
49+
See that repo for further documentation on working with Pmdarima on Conda.
50+
3651
## Quickstart Examples
3752

3853
Fitting a simple auto-ARIMA on the [`wineind`](https://alkaline-ml.com/pmdarima/modules/generated/pmdarima.datasets.load_wineind.html#pmdarima.datasets.load_wineind) dataset:

doc/setup.rst

+15
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,21 @@ the following module in python:
3333
If you encounter an ``ImportError``, try updating numpy and re-installing. Outdated
3434
numpy versions have been observed to break the pmdarima build.
3535

36+
Install from Conda
37+
------------------
38+
39+
Pmdarima is on conda under the channel ``conda-forge`` and package name ``pmdarima``. It can be downloaded via ``conda``
40+
like so:
41+
42+
.. code-block:: bash
43+
44+
$ conda config --add channels conda-forge
45+
$ conda config --set channel_priority strict
46+
$ conda install pmdarima
47+
48+
**Note:** We do not maintain our own Conda binaries, they are maintained at https://github.com/conda-forge/pmdarima-feedstock.
49+
See that repo for further documentation on working with Pmdarima on Conda.
50+
3651
Build from source
3752
-----------------
3853

0 commit comments

Comments
 (0)