Skip to content
This repository was archived by the owner on Oct 15, 2025. It is now read-only.

Commit 88a8971

Browse files
authored
Added getting started info
1 parent 28ce5ce commit 88a8971

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

README.rst

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,20 @@ diffusive_distinguishability
88
:alt: Documentation Status
99

1010

11-
Simulation of homogeneous diffusion, bayesian estimation of underlying diffusion constant and analysis of distinguishability between diffusivities (ndim_homogeneous_distinguishability.py in diffusive_distinguisbaility)
11+
Simulation of homogeneous diffusion, bayesian estimation of underlying diffusion constant and analysis of distinguishability between diffusivities
1212

13-
Jupyter notebook providing examples of how to interact with submodules of above .py, and example analysis (ndim_diffusion_analysis_tutorial.ipynb)
13+
14+
Getting Started
15+
---------------
16+
17+
The python package ``ndim_homogeneous_distinguishability.py`` contains the meat of this project, as a set of functions which can be used to:
18+
1) Simulate diffusive trajectories (pure diffusion with a homogeneous diffusion constant)
19+
2) Use Bayesian inference to estimate the diffusion constant used to generate a trajectory by producing a posterior diffusivity distribution
20+
3) Analyze the dependence of diffusivity estimation error, and the ability to distinguish between trajectories with differing diffusivities, conditional on model parameters
21+
22+
Examples of how to use these functions, as well as some of our own analysis of diffusivity distinguishability, are provided in the Jupyter notebook ``ndim_diffusion_analysis_tutorial.ipynb``.
23+
24+
Also included are some stored pre-calculated numpy arrays used in the provided Jupyter notebook example analysis (in the directory ``loc_error_saved_files``) and another Jupyter notebook containing a toy model quantifying the relative impact of localization error on diffusion estimates conditional on number of spatial dimensions (``test_overestimation.ipynb``).
1425

1526

1627
* Free software: Allen Institute Software License

0 commit comments

Comments
 (0)