Skip to content

Commit

Permalink
Updated README and docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
sarusso committed Dec 18, 2021
1 parent 7909a92 commit 21e0f90
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ It comes with a built-in set of common operations (resampling, slotting, differe

Timeseria also tries to address by design all those annoying things which are often left as an implementation detail but that actually cause wasting massive amounts of time - as handling data losses, non-uniform sampling rates, differences between time-slotted (aggregated) data and punctual observations, variable time units, timezones, DST changes and so on.

You can get started by reading the [quickstart](https://sarusso.github.io/Timeseria/Quickstart.html) or the [welcome](https://sarusso.github.io/Timeseria/Welcome.html) notebooks, or you can run them interactively in Binder using the button below. Also the [reference documentation](https://timeseria.readthedocs.io) might be useful.
You can get started by reading the [quickstart](https://sarusso.github.io/Timeseria/Quickstart.html) or the [welcome](https://sarusso.github.io/Timeseria/Welcome.html) notebooks. Also the [reference documentation](https://timeseria.readthedocs.io) might be useful.

Examples are provided in the [Timeseria-notebooks](https://github.com/sarusso/Timeseria-notebooks) repository, and a Docker image ready to be played with is available on [Docker Hub](https://hub.docker.com/r/sarusso/timeseria).

Expand Down
5 changes: 3 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ models (reconstruction, forecasting and anomaly detection), and both custom oper
Timeseria also tries to address by design all those annoying things which are often left as an implementation detail but that actually cause wasting massive amounts of time - as handling data losses, non-uniform sampling rates, differences between time-slotted data and punctual observations, variable time units, timezones, DST changes and so on.

This is the refeerence documentations, and it is quite essential. To get started more gently, you can have a look at the
`quickstart <https://sarusso.github.io/Timeseria/Quickstart.html>`_ or at the `welcome tutorial <https://sarusso.github.io/Timeseria/Welcome.html>`_ for a more structured introduction. You can also run both interactivley in
`Binder <https://mybinder.org/v2/gh/sarusso/Timeseria-notebooks/HEAD>`_.
`quickstart <https://sarusso.github.io/Timeseria/Quickstart.html>`_ or at the `welcome <https://sarusso.github.io/Timeseria/Welcome.html>`_ notebooks.

Examples are provided in the `Timeseria-notebooks <https://github.com/sarusso/Timeseria-notebooks>`_ repository, and a Docker image ready to be played with is available on `Docker Hub <https://hub.docker.com/r/sarusso/timeseria>`_.


|
Expand Down

0 comments on commit 21e0f90

Please sign in to comment.