doc:

doc: more
doc: fix format
2025-08-20 11:06:08 -05:00 · 2025-08-20 11:04:03 -05:00 · 2025-08-20 11:00:43 -05:00 · 2025-08-20 10:58:45 -05:00
1 changed files with 11 additions and 4 deletions
--- a/README.md
+++ b/README.md
@@ -2,12 +2,19 @@

 [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-green.svg?style=flat-square)](https://conventionalcommits.org)
 [![PyPI](https://img.shields.io/pypi/v/pdme?style=flat-square)](https://pypi.org/project/pdme/)
-[![Jenkins](https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fjenkins.deepak.science%2Fjob%2Fgitea-physics%2Fjob%2Fpdme%2Fjob%2Fmaster&style=flat-square)](https://jenkins.deepak.science/job/gitea-physics/job/pdme/job/master/)
-![Jenkins tests](https://img.shields.io/jenkins/tests?compact_message&jobUrl=https%3A%2F%2Fjenkins.deepak.science%2Fjob%2Fgitea-physics%2Fjob%2Fpdme%2Fjob%2Fmaster%2F&style=flat-square)
-![Jenkins Coverage](https://img.shields.io/jenkins/coverage/cobertura?jobUrl=https%3A%2F%2Fjenkins.deepak.science%2Fjob%2Fgitea-physics%2Fjob%2Fpdme%2Fjob%2Fmaster%2F&style=flat-square)
 ![Maintenance](https://img.shields.io/maintenance/yes/2024?style=flat-square)

-This repo has library code for evaluating dipole models.
+This library includes a variety of utility functions for calculating charge noise in qubits from TLSs for the purposes of Bayesian analysis.
+This was a major part of my PhD thesis on characterizing charge noise.
+New code here should be mostly low-level numpy calculations or common types that can be shared elsewhere.
+
+## Related libraries
+
+Some other libraries I wrote related to this project include:
+- [deepdog](https://gitea.deepak.science/physics/deepdog): performs Monte Carlo simulations with two underlying algorithm options for direct MC and subset simulation
+- [kalpaa](https://gitea.deepak.science/physics/kalpa): high level wrapper for pdme, deepdog and tantri, implementing retry logic, data transformation and summarising. the place to start to actually run analyses
+- [tantri](https://gitea.deepak.science/physics/tantri): generates mock telegraph noise and utility functions for binning and transforming measured or simulated power spectral densities (PSDs)
+- [dreader](https://gitea.deepak.science/physics/dreader): utility library for parsing output files

 ## Getting started
Author	SHA1	Message	Date
Deepak Mallubhotla	56f63084d6	doc: Some checks failed gitea-physics/pdme/pipeline/head There was a failure building this commit Details	2025-08-20 11:06:08 -05:00
Deepak Mallubhotla	d9db6e317c	doc: more Some checks failed gitea-physics/pdme/pipeline/head There was a failure building this commit Details	2025-08-20 11:04:03 -05:00
Deepak Mallubhotla	02398827b4	doc: fix format Some checks failed gitea-physics/pdme/pipeline/head There was a failure building this commit Details	2025-08-20 11:00:43 -05:00
Deepak Mallubhotla	340c57452d	doc: more info in readme Some checks failed gitea-physics/pdme/pipeline/head There was a failure building this commit Details	2025-08-20 10:58:45 -05:00