Skip to content

chore: JOSS paper#2163

Open
williambdean wants to merge 25 commits into
mainfrom
joss-paper
Open

chore: JOSS paper#2163
williambdean wants to merge 25 commits into
mainfrom
joss-paper

Conversation

@williambdean
Copy link
Copy Markdown
Contributor

@williambdean williambdean commented Jan 4, 2026

Description

Add a JOSS paper. View the latest here: https://github.com/pymc-labs/pymc-marketing/blob/joss-paper/paper/paper.pdf

JOSS submission: https://joss.theoj.org/papers/afedae521cb802b435e3b0833ea2a14f

JOSS Submission Details

  • Version: v0.19.4
  • Branch: joss-paper
  • Zenodo DOI: 10.5281/zenodo.20187968 — once the JOSS review issue opens, post: @editorialbot set 10.5281/zenodo.20187968 as archive

Pending

  • Add Larry Dong as author once confirmed
  • Review by the JOSS team
  • 🎉

Related Issue

Checklist

@cursor
Copy link
Copy Markdown
Contributor

cursor Bot commented Jan 4, 2026

PR Summary

Low Risk
Documentation-only change adding manuscript sources; no runtime code paths or data handling are affected.

Overview
Adds a JOSS submission under paper/, including a new paper.md manuscript (metadata, summary, feature overview, funding/AI disclosure, etc.) and a paper.bib bibliography with the referenced citations.

No library code, APIs, or runtime behavior changes are included—this PR is purely publication/documentation content.

Written by Cursor Bugbot for commit daec1e5. This will update automatically on new commits. Configure here.

@github-actions github-actions Bot added the docs Improvements or additions to documentation label Jan 4, 2026
@williambdean williambdean requested a review from Copilot January 4, 2026 20:29
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds a JOSS (Journal of Open Source Software) paper for PyMC-Marketing, which is a preparatory step before formal submission to JOSS for peer review and publication.

  • Introduces a comprehensive academic paper describing PyMC-Marketing's features and capabilities
  • Includes bibliography with citations to relevant academic and technical sources
  • Provides example code demonstrating the library's key functionality

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File Description
paper/paper.md JOSS paper manuscript containing summary, statement of need, installation instructions, key features, example usage, and community guidelines
paper/paper.bib Bibliography file with BibTeX entries for all cited references in the paper

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread paper/paper.md Outdated
Comment thread paper/paper.bib Outdated
Comment thread paper/paper.bib Outdated
Comment thread paper/paper.md Outdated
Copy link
Copy Markdown
Collaborator

@ColtAllen ColtAllen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In addition to the author section, should we also add usage examples for the other modules in the library?

Comment thread paper/paper.md
@williambdean
Copy link
Copy Markdown
Contributor Author

williambdean commented Jan 5, 2026

In addition to the author section, should we also add usage examples for the other modules in the library?

I'm actually leaning toward removing all examples. The guidelines I've seen appear to be
1K word count which we are already over.

Copy link
Copy Markdown
Collaborator

@juanitorduz juanitorduz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great! I left a first round of comments (shall we also push the pdf to the branch?)

Comment thread paper/paper.md
Comment thread paper/paper.md
Comment thread paper/paper.md Outdated
Comment thread paper/paper.md Outdated
Comment thread paper/paper.md Outdated
Comment thread paper/paper.md Outdated
Comment thread paper/paper.md Outdated
Comment thread paper/paper.md Outdated
Comment thread paper/paper.md
Copy link
Copy Markdown
Collaborator

@juanitorduz juanitorduz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing ohter author ;)

@williambdean
Copy link
Copy Markdown
Contributor Author

williambdean commented Jan 5, 2026

I've pushed up a version of the PDF. Please use:

docker run --rm \
    --volume $PWD/paper:/data \
    --user $(id -u):$(id -g) \
    --env JOURNAL=joss \
    openjournals/inara

to generate the draft. View it here: https://github.com/pymc-labs/pymc-marketing/blob/joss-paper/paper/paper.pdf

Copy link
Copy Markdown
Collaborator

@OriolAbril OriolAbril left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure what is the timeline but it would also be nice to update the citation to the new arviz paper if possible, but also not a reason to delay the paper. It is key for #2098 but not used anywhere on main yet

Comment thread paper/paper.bib Outdated
Comment thread paper/paper.md Outdated
Comment thread paper/paper.md Outdated
Comment thread paper/paper.md Outdated
Comment thread paper/paper.md Outdated
Comment thread paper/paper.md Outdated
Co-authored-by: Thomas Wiecki <thomas.wiecki@gmail.com>
Comment thread paper/paper.md Outdated
@OriolAbril
Copy link
Copy Markdown
Collaborator

Do you have a rough ETA?

Ideally at some point next week, at most the other one.

@juanitorduz
Copy link
Copy Markdown
Collaborator

Do you have a rough ETA?

Ideally at some point next week, at most the other one.

Sure! We can wait, of course! 💪

@PabloRoque
Copy link
Copy Markdown
Contributor

Any non-labs contributors that have done large enough contributions to deserve being authors?

@PabloRoque added ADVI support, the MG/BND model, and covariate support for beta distributions. His research on the latter also uncovered a bug in how the BYTDPlus R library handles covariates.

Hey, just seeing this after the long Xmas break.
I would be glad to be acknowledged as contributor. Should I add my ORCID?

Co-authored-by: Luciano Paz <luciano.paz.neuro@gmail.com>
@juanitorduz
Copy link
Copy Markdown
Collaborator

yes @PabloRoque ! That would be great!

Copy link
Copy Markdown
Contributor

@PabloRoque PabloRoque left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added my ORCID

Comment thread paper/paper.md
Copy link
Copy Markdown
Collaborator

@juanitorduz juanitorduz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adding @NathanielF

Comment thread paper/paper.md Outdated
Comment thread paper/paper.md Outdated
Copy link
Copy Markdown
Collaborator

@juanitorduz juanitorduz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we are just missing Carlos Id and then update the ArviZ reference right? @williambdean

@williambdean
Copy link
Copy Markdown
Contributor Author

I think we are just missing Carlos Id and then update the ArviZ reference right? @williambdean

Yup. Then I will begin the submittal process. That seems to be long

@OriolAbril
Copy link
Copy Markdown
Collaborator

The ArviZ paper is already in pre-review: openjournals/joss-reviews#9786

Copy link
Copy Markdown
Collaborator

@juanitorduz juanitorduz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@williambdean did we update the arviz reference? anything else missing :) ?

Comment thread paper/paper.md Outdated
@drbenvincent
Copy link
Copy Markdown
Contributor

Based on this discussion from @ErikRingen, it made me realise I should update my affiliation to my company rather than Labs. Got to be careful on the tax side of things. Could be relevant for others with companies too?

Copy link
Copy Markdown
Contributor

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Comment thread paper/paper.md Outdated
Copy link
Copy Markdown
Collaborator

@juanitorduz juanitorduz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

I suggest adding @isofer as a coauthor. Can you please provide your ORCID please?

@isofer
Copy link
Copy Markdown
Contributor

isofer commented May 5, 2026

Looks great!

I suggest adding @isofer as a coauthor. Can you please provide your ORCID please?

Just created one: https://orcid.org/0009-0002-5367-3850

- Add HelloFresh, Bolt, and Runge & Pauwels (2026) citations
- Remove Lemonade preprint citation per team feedback
- Remove Larry Dong pending affiliation confirmation
- Fix Erik Ringen affiliation index after Larry removal
- Rename Carlos to full legal name
- Update MMM terminology to match repo style (Marketing Mix Models)
- Add Imri Sofer as author
- Update date to 14 May 2026
- Gitignore paper/jats/ build artifacts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Publish paper about this package in JOSS