Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update installation instructions to use conda-forge #253

Merged
merged 2 commits into from
Apr 19, 2023
Merged

Update installation instructions to use conda-forge #253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
965a1f2
Install via conda-forge package
maresb Apr 18, 2023
7e600d7
Update installation instructions in docs
maresb Apr 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,15 @@

## Installation

Start by setting up an environment (e.g. `marketing_env`) with PyMC. It may look something like the following:
Install and activate an environment (e.g. `marketing_env`) with the `pymc-marketing` package from [conda-forge](https://conda-forge.org). It may look something like the following:

```bash
mamba create -c conda-forge -n marketing_env python "pymc>=5"
mamba create -c conda-forge -n marketing_env pymc-marketing
mamba activate marketing_env
```

See the official [PyMC installation guide](https://www.pymc.io/projects/docs/en/latest/installation.html) if more detail is needed.

Assuming you have an environment set up then install PyMC-Marketing with the following command. This will give you the latest version of the library from PyPI.

```bash
pip install pymc-marketing
```

Alternatively you can install from GitHub directly:

```bash
Expand Down
28 changes: 18 additions & 10 deletions docs/source/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,36 +59,44 @@ To the reference guide

## Installation

Start by setting up an environment (e.g. `marketing_env`) with PyMC. It may look something like the following:
Install and activate an environment (e.g. `marketing_env`) with the `pymc-marketing` package from [conda-forge](https://conda-forge.org). It may look something like the following:

```bash
mamba create -c conda-forge -n marketing_env python "pymc>=5"
mamba create -c conda-forge -n marketing_env pymc-marketing
mamba activate marketing_env
```

See the official [PyMC installation guide](https://www.pymc.io/projects/docs/en/latest/installation.html) if more detail is needed.

Assuming you have an environment set up then install PyMC-Marketing with the following command. This will give you the latest version of the library from PyPI.
For testing purposes, if you wish to install the `main` branch directly from GitHub:

```bash
pip install pymc-marketing
pip install git+https://github.com/pymc-labs/pymc-marketing.git
```

Alternatively you can install from GitHub directly:
## Quickstart

Create a new Jupyter notebook with either JupyterLab or VS Code.

### JupyterLab Notebook

After installing the `pymc-marketing` package (see above), run the following with `marketing_env` activated:

```bash
pip install git+https://github.com/pymc-labs/pymc-marketing.git
mamba install -c conda-forge jupyterlab
jupyter lab
```

## Quickstart
### VS Code Notebook

Once you've installed the library (see above), you can get started. If you want to work in a jupyter lab notebook then remember to do the following:
After installing the `pymc-marketing` package (see above), run the following with `marketing_env` activated:

```bash
pip install jupyterlab
python -m ipykernel install --user --name marketing_env
mamba install -c conda-forge ipykernel
```

Start VS Code and ensure that the "Jupyter" extension is installed. Press Ctrl + Shift + P and type "Python: Select Interpreter". Ensure that `marketing_env` is selected. Press Ctrl + Shift + P and type "Create: New Jupyter Notebook".

### MMM Quickstart

```python
Expand Down