Updates to readme and actions

.github/workflows/python-package.yml

@@ -92,6 +92,7 @@ jobs:
 
   publish-test:
     # https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+    if: startsWith(github.ref, 'refs/tags/')
     needs:
       - build
     runs-on: ubuntu-latest

README.md

@@ -1,9 +1,8 @@
 # mssm: Markov-switching Spline Models
 
 ## Description
-``mssm`` is a toolbox to estimate Generalized Additive Mixed Models (GAMMs) semi Markov-switching GAMMs (sMs-GAMMs) and sMs Impulse Response GAMMs (sMs-IR-GAMMs).
-The ``main`` branch is updated frequently to reflect new developments. The ``stable`` branch should reflect the latest releases. if you don't need the latest functionality, you
-should install from the ``stable`` branch (see below for instructions).
+
+``mssm`` is a toolbox to estimate Generalized Additive Mixed Models (GAMMs) semi Markov-switching GAMMs (sMs-GAMMs) and sMs Impulse Response GAMMs (sMs-IR-GAMMs). The ``main`` branch is updated frequently to reflect new developments. The ``stable`` branch should reflect the latest releases. if you don't need the newest functionality, you should install from the ``stable`` branch (see below for instructions).
 
 ## Installation
 
@@ -16,10 +15,14 @@ Currently, mssm can only be installed from [test.pypi](https://test.pypi.org/pro
 
 ```
 conda create -n mssm_env python=3.10
+conda activate mssm_env
 pip install -i https://test.pypi.org/simple/ mssm
+pip install matplotlib # Only needed for tutorials
 ```
 
-Once ``mssm`` can be published to pypi, you can replace the second line with ``pip install mssm``. Note: pypi will only reflect releases on the ``stable`` branch. Pushes to main will however continue to be distributed to test.pypi, so if you need the latest changes you can get them from there.
+Once ``mssm`` can be published to pypi, you can replace the third line with ``pip install mssm``. The fourth line, installing ``matplotlib`` is only necessary if you want to run the tutorials. Note: pypi will only reflect releases on the ``stable`` branch. Tagged pushes to main will however continue to be distributed to test.pypi, so if you need the latest changes you can get them from there.
+
+### Building from source
 
 You can also build directly from source. This requires ``conda`` or an installation of [eigen](https://eigen.tuxfamily.org/index.php?title=Main_Page)(``setup.py`` then expects ``eigen`` in "usr/local/include/eigen3". This will probably not work on windows.). Once you have ``conda`` installed,
 [install eigen from conda-forge](https://anaconda.org/conda-forge/eigen). After cloning and navigating into the downloaded repository you can then install via ``pip install . ``.
@@ -29,3 +32,7 @@ You can also build directly from source. This requires ``conda`` or an installat
  - With GAMMs: Take a look at tutorial 1 in the tutorial folder.
  - With sms-IR-GAMMs: Take a look at tutorial 2.
  - With sms-GAMMs: Take a look at tutorial 3.
+
+## Contributing
+
+Contributions are welcome! Feel free to open issues or make pull-requests to main.

pyproject.toml

@@ -1,6 +1,7 @@
 [build-system]
 requires = [
     "setuptools>=60",
+    "setuptools-scm>=8.0",
     "GitPython>=3.1.4",
     "pybind11>=2.10.0",
 ]
@@ -11,7 +12,6 @@ dependencies=["numpy >= 1.24.1",
               "pandas >= 1.5.3",
               "scipy >= 1.10.0"]
 name = "mssm"
-version = "0.1.1"
 authors = [
   { name="Joshua Krause", email="jokra001@proton.me" }
 ]
@@ -22,3 +22,7 @@ classifiers = [
     "Programming Language :: Python :: 3",
     "Operating System :: OS Independent",
 ]
+# https://pypi.org/project/setuptools-scm/ - automatic version number based on tag
+dynamic = ["version"]
+
+[tool.setuptools_scm]