You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
PINTS (Probabilistic Inference on Noisy Time-Series) is a framework for optimisation and Bayesian inference.
12
13
Although it can be used as a general-purpose inference tool, it was developed specifically for models of noisy time-series, such as arise in electrochemistry and cardiac electrophysiology.
13
14
14
-
PINTS is described in [this publication in JORS](http://doi.org/10.5334/jors.252), and can be cited using the information given in our [CITATION file](https://github.com/pints-team/pints/blob/main/CITATION).
15
+
PINTS is described in [this publication in JORS](http://doi.org/10.5334/jors.252) and can be cited using the information given in our [CITATION file](https://github.com/pints-team/pints/blob/main/CITATION).
15
16
More information about PINTS papers can be found in the [papers directory](https://github.com/pints-team/pints/tree/main/papers).
16
17
18
+
17
19
## Using PINTS
18
20
19
21
PINTS can work with any model that implements the [pints.ForwardModel](http://pints.readthedocs.io/en/latest/core_classes_and_methods.html#forward-model) interface.
@@ -30,7 +32,9 @@ Experimental data sets in PINTS are defined simply as lists (or arrays) of `time
30
32
If you have this kind of data, and if [your model (or model wrapper)](https://github.com/pints-team/pints/blob/main/examples/stats/custom-model.ipynb) implements the two methods above, then you are ready to start using PINTS to infer parameter values using [optimisation](https://github.com/pints-team/pints/blob/main/examples/optimisation/first-example.ipynb) or [sampling](https://github.com/pints-team/pints/blob/main/examples/sampling/first-example.ipynb).
31
33
32
34
A brief example is shown below:
35
+
33
36

37
+
34
38
_(Left)_ A noisy experimental time series and a computational forward model.
35
39
_(Right)_ Example code for an optimisation problem.
36
40
The full code can be [viewed here](https://github.com/pints-team/pints/blob/main/examples/sampling/readme-example.ipynb) but a friendlier, more elaborate, introduction can be found on the [examples page](https://github.com/pints-team/pints/blob/main/examples/README.md).
@@ -39,6 +43,7 @@ Beyond time-series models, PINTS can be used on any error function or log-likeli
39
43
40
44
An overview of the methods provided by PINTS can be [viewed here](https://pints.readthedocs.io/en/latest/#provided-methods).
41
45
46
+
42
47
### Examples and documentation
43
48
44
49
PINTS comes with a number of [detailed examples](https://github.com/pints-team/pints/blob/main/examples/README.md), hosted here on github.
@@ -47,7 +52,7 @@ In addition, there is a [full API documentation](http://pints.readthedocs.io/en/
47
52
48
53
## Installing PINTS
49
54
50
-
The latest release of PINTS can be installed without downloading (cloning) the git repository, by opening a console and typing
55
+
The latest release of PINTS can be installed with `pip`, by opening a console and typing
51
56
52
57
```
53
58
$ pip install --upgrade pip
@@ -78,19 +83,20 @@ To see what's changed in the latest release, see the [CHANGELOG](https://github.
78
83
79
84
## Contributing to PINTS
80
85
81
-
There are lots of ways to contribute to PINTS development, and anyone is free to join in!
86
+
There are lots of ways to contribute to PINTS development, and anyone is free to join in.
82
87
For example, you can report problems or make feature requests on the [issues](https://github.com/pints-team/pints/issues) pages.
83
88
84
89
Similarly, if you want to contribute documentation or code you can tell us your idea on this page, and then provide a pull request for review.
85
90
Because PINTS is a big project, we've written extensive [contribution guidelines](https://github.com/pints-team/pints/blob/master/CONTRIBUTING.md) to help standardise the code — but don't worry, this will become clear during review.
86
91
92
+
87
93
## License
88
94
89
-
PINTS is fully open source. For more information about its license, see [LICENSE](https://github.com/pints-team/pints/blob/main/LICENSE.md).
95
+
PINTS is fully open source.
96
+
For more information about its license, see [LICENSE](https://github.com/pints-team/pints/blob/main/LICENSE.md).
90
97
91
98
92
99
## Get in touch
93
100
94
-
Questions, suggestions, or bug reports? [Open an issue](https://github.com/pints-team/pints/issues) and let us know.
95
-
96
-
Alternatively, feel free to email us at `pints at maillist.ox.ac.uk`.
101
+
Questions, suggestions, or bug reports?
102
+
[Start a discussion](https://github.com/pints-team/pints/discussions) or [open an issue](https://github.com/pints-team/pints/issues) to let us know!
0 commit comments