Merge pull request #39 from decarsg/feature/add-citation-cff

Feature/add citation cff

.github/workflows/release-package.yml

@@ -0,0 +1,24 @@
+name: Release package
+on:
+  release:
+    types: [published]
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{secrets.PYPI_API_TOKEN}}

.github/workflows/test-package.yml

@@ -0,0 +1,27 @@
+name: Test package
+on:
+  push:
+    branches: [main, dev]
+  pull_request:
+    branches: [main, dev]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.7, 3.8, 3.9]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{matrix.python-version}}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{matrix.python-version}}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Test with pytest
+      run: |
+        pytest ./tests -k-slow

CITATION.cff

@@ -0,0 +1,12 @@
+cff-version: 1.1.0
+message: "If you use this software, please cite it as below."
+authors:
+  - family-names: Dahdah
+    given-names: Steven
+    orcid: https://orcid.org/0000-0003-4930-9634
+  - family-names: Forbes
+    given-names: James Richard
+    orcid: https://orcid.org/0000-0002-1987-9268
+title: decarsg/pykoop: v1.0.2
+version: v1.0.2
+date-released: 2017-12-18

README.rst

@@ -3,6 +3,10 @@ pykoop
 
 .. image:: https://zenodo.org/badge/392435742.svg
    :target: https://zenodo.org/badge/latestdoi/392435742
+    :alt: DOI
+.. image:: https://readthedocs.org/projects/pykoop/badge/?version=latest
+    :target: https://pykoop.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
 
 ``pykoop`` is a Koopman operator identification library written in Python. It
 allows the user to specify Koopman lifting functions and regressors in order to
@@ -145,7 +149,7 @@ Library      Unique features
              - Detailed DMD outputs
              - DMDc with known control matrix
 `PyDMD`_     - Extensive library containing pretty much every variant of DMD
-`PySINDy`_   - Python implementation of the famous (SINDy) method
+`PySINDy`_   - Python implementation of the famous SINDy method
              - Related to, but not the same as, Koopman operator approximation
 ============ ==================================================================
 
@@ -161,6 +165,23 @@ References
    approaches to Koopman operator approximation." arXiv:2102.03613 [eess.SY]
    (2021). https://arxiv.org/abs/2102.03613
 
+Citation
+========
+
+If you use this software in your research, please cite it as below or see
+``CITATION.cff``.
+
+.. code-block:: bibtex
+
+    @software{dahdah_pykoop_2021,
+        title={{decarsg/pykoop}},
+        doi={10.5281/zenodo.5576490},
+        url={https://github.com/decarsg/pykoop},
+        publisher={Zenodo},
+        author={Steven Dahdah and James Richard Forbes},
+        year={2021},
+    }
+
 License
 =======
 

doc/index.rst

@@ -6,6 +6,13 @@
 pykoop
 ======
 
+.. image:: https://zenodo.org/badge/392435742.svg
+   :target: https://zenodo.org/badge/latestdoi/392435742
+    :alt: DOI
+.. image:: https://readthedocs.org/projects/pykoop/badge/?version=latest
+    :target: https://pykoop.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
 ``pykoop`` is a Koopman operator identification library written in Python. It
 allows the user to specify Koopman lifting functions and regressors in order to
 learn a linear model of a given system in the lifted space.
@@ -145,9 +152,9 @@ Library      Unique features
 `pykoopman`_ - Continuous-time Koopman operator identification
              - Built-in numerical differentiation
              - Detailed DMD outputs
-             - DMDc with known control
+             - DMDc with known control matrix
 `PyDMD`_     - Extensive library containing pretty much every variant of DMD
-`PySINDy`_   - Python implementation of the famous (SINDy) method
+`PySINDy`_   - Python implementation of the famous SINDy method
              - Related to, but not the same as, Koopman operator approximation
 ============ ==================================================================
 
@@ -173,6 +180,23 @@ References
    dynamics." arXiv:2010.09961v3 [cs.RO] (2020).
    https://arxiv.org/abs/2010.09961v3
 
+Citation
+========
+
+If you use this software in your research, please cite it as below or see
+``CITATION.cff``.
+
+.. code-block:: bibtex
+
+    @software{dahdah_pykoop_2021,
+        title={{decarsg/pykoop}},
+        doi={10.5281/zenodo.5576490},
+        url={https://github.com/decarsg/pykoop},
+        publisher={Zenodo},
+        author={Steven Dahdah and James Richard Forbes},
+        year={2021},
+    }
+
 License
 =======
 

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name='pykoop',
-    version='1.0.1',
+    version='1.0.2',
     description='Koopman operator identification library in Python',
     long_description=readme,
     author='Steven Dahdah',
@@ -17,6 +17,13 @@
         'Operating System :: OS Independent',
         'Topic :: Scientific/Engineering',
     ],
+    project_urls={
+        'Documentation': 'https://pykoop.readthedocs.io/en/latest',
+        'Source': 'https://github.com/decarsg/pykoop',
+        'Tracker': 'https://github.com/decarsg/pykoop/issues',
+        'PyPI': 'https://pypi.org/project/pykoop/',
+        'DOI': 'https://doi.org/10.5281/zenodo.5576490',
+    },
     packages=setuptools.find_packages(exclude=('tests', 'examples', 'doc')),
     python_requires='>=3.7',
     install_requires=[