Skip to content

Commit c376edb

Browse files
Add telemetry page (#220)
Added telemetry page so the information is not just in the release notes. I have basically copied the information across.
1 parent 33cc3af commit c376edb

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

config.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ params:
9393
is_external: true
9494
- title: Governance
9595
url: /governance/
96+
- title: Telemetry
97+
url: /telemetry/
9698
- title: PyBaMM Teams
9799
url: /teams/
98100

content/telemetry.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Telemetry
3+
shortcutDepth: 2
4+
summary: Information about the telemetry collection system in PyBaMM
5+
---
6+
7+
From release 24.11 onwards, PyBaMM includes an **opt-in** telemetry collection system to help us better understand how PyBaMM is being used. This system collects anonymous usage data, such as the version of PyBaMM being used, the operating system, and the Python version. This data will help us make informed decisions about the future of PyBaMM. We would like to assure you that no personal data is collected, and the data is only used by the PyBaMM team. Here are some details:
8+
9+
- **What is collected**: Basic usage information like PyBaMM version, Python version, and which functions are run.
10+
- **Why**: To understand how PyBaMM is used and prioritize development efforts.
11+
- **Permanent opt-out**: To disable telemetry permanently, set the environment variable `PYBAMM_DISABLE_TELEMETRY=true` (or any value other than `false`) or use `pybamm.telemetry.disable()` in your code. You can also select "no" when PyBaMM asks if you would like to enable telemetry.
12+
- **Privacy**: No personal information (name, email, etc) or sensitive information (parameter values, simulation results, etc) is ever collected. The data is used only by the PyBaMM team and is not shared with any third parties. The data is stored securely and is only accessible to the PyBaMM team. Please read PostHog's policy on [GDPR compliance](https://posthog.com/docs/privacy/gdpr-compliance) for more.

0 commit comments

Comments
 (0)