Skip to content

Commit

Permalink
final
Browse files Browse the repository at this point in the history
  • Loading branch information
pswpswpsw committed Jun 20, 2023
1 parent fd4c88c commit 92f6390
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PyKoopman
=========

|Build| |Docs| |PyPI| |Codecov|
|Build| |Docs| |PyPI| |Codecov| |DOI|

**PyKoopman** is a Python package for computing data-driven approximations to the Koopman operator.

Expand Down Expand Up @@ -47,8 +47,8 @@ We design ``PyKoopman`` such that it is compatible to ``scikit-learn`` objects a



Example
^^^^^^^
Examples
^^^^^^^^

1. `Learning how to create observables <https://pykoopman.readthedocs
.io/en/master/tutorial_compose_observables
Expand Down Expand Up @@ -183,15 +183,31 @@ Reporting issues or bugs
^^^^^^^^^^^^^^^^^^^^^^^^
If you find a bug in the code or want to request a new feature, please open an issue.

Citing PySINDy
--------------

(To be filled)

Related packages
----------------
* `PySINDy <https://github.com/dynamicslab/pysindy/>`_ - A Python libray for the Sparse Identification of Nonlinear Dynamical
systems (SINDy) method introduced in Brunton et al. (2016a).
* `Deeptime <https://github.com/deeptime-ml/deeptime>`_ - A Python library for the analysis of time series data with methods for dimension reduction, clustering, and Markov model estimation.
* `PyDMD <https://github.com/mathLab/PyDMD/>`_ - A Python package using the Dynamic Mode Decomposition (DMD) for a data-driven model simplification based on spatiotemporal coherent structures. DMD is a great alternative to SINDy.


.. |Build| image:: https://github.com/dynamicslab/pykoopman/workflows/Tests/badge.svg
:target: https://github.com/dynamicslab/pykoopman/actions?query=workflow%3ATests

.. |Docs| image:: https://readthedocs.org/projects/pykoopman/badge/?version=latest
:target: https://pykoopman.readthedocs.io/en/master/badge/?version=latest
.. |Docs| image:: https://readthedocs.org/projects/pykoopman/badge/?version=master
:target: https://pykoopman.readthedocs.io/en/master/?badge=master
:alt: Documentation Status

.. |PyPI| image:: https://badge.fury.io/py/pykoopman.svg
:target: https://badge.fury.io/py/pykoopman

.. |Codecov| image:: https://codecov.io/github/dynamicslab/pykoopman/coverage.svg
:target: https://app.codecov.io/gh/dynamicslab/pykoopman

.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8041854.svg
:target: https://doi.org/10.5281/zenodo.8041854

0 comments on commit 92f6390

Please sign in to comment.