Skip to content

Commit 8ff544e

Browse files
authored
Update README.md
1 parent c53b401 commit 8ff544e

1 file changed

Lines changed: 13 additions & 7 deletions

File tree

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@
66
[![binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/pints-team/pints/main?filepath=examples)
77
[![readthedocs](https://readthedocs.org/projects/pints/badge/?version=latest)](http://pints.readthedocs.io/en/latest/?badge=latest)
88

9+
910
# What is Pints?
1011

1112
PINTS (Probabilistic Inference on Noisy Time-Series) is a framework for optimisation and Bayesian inference.
1213
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.
1314

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).
1516
More information about PINTS papers can be found in the [papers directory](https://github.com/pints-team/pints/tree/main/papers).
1617

18+
1719
## Using PINTS
1820

1921
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
3032
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).
3133

3234
A brief example is shown below:
35+
3336
![An example of using PINTS in an optimisation](https://raw.githubusercontent.com/pints-team/pints/main/example.svg)
37+
3438
_(Left)_ A noisy experimental time series and a computational forward model.
3539
_(Right)_ Example code for an optimisation problem.
3640
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
3943

4044
An overview of the methods provided by PINTS can be [viewed here](https://pints.readthedocs.io/en/latest/#provided-methods).
4145

46+
4247
### Examples and documentation
4348

4449
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/
4752

4853
## Installing PINTS
4954

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
5156

5257
```
5358
$ pip install --upgrade pip
@@ -78,19 +83,20 @@ To see what's changed in the latest release, see the [CHANGELOG](https://github.
7883

7984
## Contributing to PINTS
8085

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.
8287
For example, you can report problems or make feature requests on the [issues](https://github.com/pints-team/pints/issues) pages.
8388

8489
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.
8590
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.
8691

92+
8793
## License
8894

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).
9097

9198

9299
## Get in touch
93100

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

Comments
 (0)