===============================
Citations
===============================
Dahm, Torsten; Hainzl, Sebastian; Dahm, Roman Albert (2022): Time-dependent stress response seismicity models (TDSR). GFZ Data Services. https://doi.org/10.5880/GFZ.2.1.2022.002
Dahm, Torsten and hainzl, Sebastian (2022): A Coulomb Stress response model for time-dependent earthquake forecasts. Journal of Geophysical Research, Solid Earth, http://doi.org/10.1029/2022JB024443
===============================
tdsr
===============================
.. image:: https://github.com/torstendahm/tdsr/workflows/test/badge.svg
:target: https://github.com/torstendahm/tdsr/actions
:alt: Build Status
.. image:: https://img.shields.io/pypi/v/tdsr.svg
:target: https://pypi.python.org/pypi/tdsr
:alt: PyPI version
.. image:: https://img.shields.io/github/license/torstendahm/tdsr
:target: https://github.com/torstendahm/tdsr
:alt: License
.. image:: https://img.shields.io/badge/docs-tdsr-green
:target: https://torstendahm.github.io/tdsr
:alt: Documentation
""""""""
Time dependent stress response seismicity model.
A modified effective Coulomb failure model, that calculates earthquake rate as a function of stress loading and model parameter
.. code-block:: console
$ pip install tdsr
Usage
-----
Usage instructions t.b.a.
.. code-block:: python
import tdsr
Development
-----------
If you want to contribute to ``tdsr``, we highly recommend setting up a virtual environment for local development. You can easily do so with ``pipenv``, which can be installed with ``pip install --user pipenv`` (`instructions <https://pipenv.pypa.io/en/latest/install/>`_) by following the steps below. Note that all commands should be run in the top level directory of the cloned ``tdsr`` repository.
.. code-block:: bash
$ git clone https://github.com/torstendahm/tdsr.git
$ cd tdsr
$ pipenv install --dev
With the virtual environment set up, activate it with ``pipenv shell``. To exit the virtual environment, run ``exit``.
+++++++
Testing
+++++++
Tests are located in the ``/tests`` directory. To add a new test, add a file with a function name starting with ``test``. To run the full test suite, run:
.. code-block:: bash
$ invoke test
$ pytest # can also directly run pytest with custom options
This will run tests serially and fail on the first error, which is preferred for local debugging.
However, this behaviour can also be changed with ``invoke test --[no-]fail-fast --parallel``.
++++++++++
Code style
++++++++++
``tdsr`` provides automatic code formatting and checks code for conformance.
.. code-block:: bash
$ invoke format # format python files
$ invoke lint # lint python files
$ invoke type-check # check for mypy typing errors
$ invoke pre-commit # run all of above checks
To pass CI, ensure that ``invoke pre-commit`` passes all checks.
+++++++++++++
Documentation
+++++++++++++
`Sphinx <https://www.sphinx-doc.org/en/master/>`_ is used to build the documentation website, which uses reStructuredText (rst).
See `this website <https://sublime-and-sphinx-guide.readthedocs.io/en/latest/>`_ for examples of how to use rst.
To build and preview the documentation locally, you can use
.. code-block:: bash
$ invoke docs
This will start a local webserver and open the documentation in the browser for you.
If this is not needed, use the ``--no-serve`` flag.
++++++++++
Releases
++++++++++
**Note:** This is only relevant for maintainers.
Given a clean working tree on the master branch, a release of a new version of ``tdsr`` to `pypi <https://pypi.org/>`_
can be triggered by creating and pushing a new git tag.
The github action CICD pipeline will test, package, and publish the new version automatically.
Before attempting a new release, please make sure all code checks pass.
We use semantic version strings of the form ``{major}.{minor}.{patch}``.
Depending on the type of release, choose the part of the version to be incremented in the command below.
.. code-block:: bash
$ bump2version patch
$ git push --follow-tags
Remember to activate the virtual environment as previously outlined if ``bump2version`` is not found.
Raw data
{
"_id": null,
"home_page": "https://github.com/torstendahm/tdsr",
"name": "tdsr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "tdsr",
"author": "torstendahm",
"author_email": "torsten.dahm@gfz-potsdam.de",
"download_url": "https://files.pythonhosted.org/packages/12/3f/121f20d63b158248ba0efaaebd2f9d37a1e9687ebd0b51a8fb48d09e5f88/tdsr-0.0.8.tar.gz",
"platform": null,
"description": "===============================\nCitations\n===============================\nDahm, Torsten; Hainzl, Sebastian; Dahm, Roman Albert (2022): Time-dependent stress response seismicity models (TDSR). GFZ Data Services. https://doi.org/10.5880/GFZ.2.1.2022.002\nDahm, Torsten and hainzl, Sebastian (2022): A Coulomb Stress response model for time-dependent earthquake forecasts. Journal of Geophysical Research, Solid Earth, http://doi.org/10.1029/2022JB024443\n\n===============================\ntdsr\n===============================\n\n.. image:: https://github.com/torstendahm/tdsr/workflows/test/badge.svg\n :target: https://github.com/torstendahm/tdsr/actions\n :alt: Build Status\n\n.. image:: https://img.shields.io/pypi/v/tdsr.svg\n :target: https://pypi.python.org/pypi/tdsr\n :alt: PyPI version\n\n.. image:: https://img.shields.io/github/license/torstendahm/tdsr\n :target: https://github.com/torstendahm/tdsr\n :alt: License\n\n.. image:: https://img.shields.io/badge/docs-tdsr-green\n :target: https://torstendahm.github.io/tdsr\n :alt: Documentation\n\n\"\"\"\"\"\"\"\"\n\nTime dependent stress response seismicity model.\n\nA modified effective Coulomb failure model, that calculates earthquake rate as a function of stress loading and model parameter\n\n.. code-block:: console\n\n $ pip install tdsr\n\nUsage\n-----\n\nUsage instructions t.b.a.\n\n.. code-block:: python\n\n import tdsr\n\n\nDevelopment\n-----------\n\nIf you want to contribute to ``tdsr``, we highly recommend setting up a virtual environment for local development. You can easily do so with ``pipenv``, which can be installed with ``pip install --user pipenv`` (`instructions <https://pipenv.pypa.io/en/latest/install/>`_) by following the steps below. Note that all commands should be run in the top level directory of the cloned ``tdsr`` repository.\n\n.. code-block:: bash\n\n $ git clone https://github.com/torstendahm/tdsr.git\n $ cd tdsr\n $ pipenv install --dev\n\nWith the virtual environment set up, activate it with ``pipenv shell``. To exit the virtual environment, run ``exit``.\n\n+++++++\nTesting\n+++++++\n\nTests are located in the ``/tests`` directory. To add a new test, add a file with a function name starting with ``test``. To run the full test suite, run:\n\n.. code-block:: bash\n\n $ invoke test\n $ pytest # can also directly run pytest with custom options\n\nThis will run tests serially and fail on the first error, which is preferred for local debugging.\nHowever, this behaviour can also be changed with ``invoke test --[no-]fail-fast --parallel``.\n\n++++++++++\nCode style\n++++++++++\n\n``tdsr`` provides automatic code formatting and checks code for conformance.\n\n.. code-block:: bash\n\n $ invoke format # format python files\n $ invoke lint # lint python files\n $ invoke type-check # check for mypy typing errors\n $ invoke pre-commit # run all of above checks\n\nTo pass CI, ensure that ``invoke pre-commit`` passes all checks.\n\n+++++++++++++\nDocumentation\n+++++++++++++\n\n`Sphinx <https://www.sphinx-doc.org/en/master/>`_ is used to build the documentation website, which uses reStructuredText (rst).\nSee `this website <https://sublime-and-sphinx-guide.readthedocs.io/en/latest/>`_ for examples of how to use rst.\n\nTo build and preview the documentation locally, you can use\n\n.. code-block:: bash\n\n $ invoke docs\n\nThis will start a local webserver and open the documentation in the browser for you.\nIf this is not needed, use the ``--no-serve`` flag.\n\n++++++++++\nReleases\n++++++++++\n\n**Note:** This is only relevant for maintainers.\n\nGiven a clean working tree on the master branch, a release of a new version of ``tdsr`` to `pypi <https://pypi.org/>`_\ncan be triggered by creating and pushing a new git tag.\n\nThe github action CICD pipeline will test, package, and publish the new version automatically.\nBefore attempting a new release, please make sure all code checks pass.\n\nWe use semantic version strings of the form ``{major}.{minor}.{patch}``.\nDepending on the type of release, choose the part of the version to be incremented in the command below.\n\n.. code-block:: bash\n\n $ bump2version patch\n $ git push --follow-tags\n\nRemember to activate the virtual environment as previously outlined if ``bump2version`` is not found.\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "tdsr",
"version": "0.0.8",
"project_urls": {
"Homepage": "https://github.com/torstendahm/tdsr"
},
"split_keywords": [
"tdsr"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b2c88eea857c487ba14f7dbdb2baebf25f5af1d454b942a76f193671752b534f",
"md5": "fa3b99ca6a68589a33d73dd68f9d573c",
"sha256": "0a5ab3bd71e5e95b8f7ea7e87d826570a8788e33380f362c73ff8c4620dca101"
},
"downloads": -1,
"filename": "tdsr-0.0.8-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "fa3b99ca6a68589a33d73dd68f9d573c",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 37134,
"upload_time": "2023-12-26T17:53:54",
"upload_time_iso_8601": "2023-12-26T17:53:54.994751Z",
"url": "https://files.pythonhosted.org/packages/b2/c8/8eea857c487ba14f7dbdb2baebf25f5af1d454b942a76f193671752b534f/tdsr-0.0.8-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "123f121f20d63b158248ba0efaaebd2f9d37a1e9687ebd0b51a8fb48d09e5f88",
"md5": "714fad004e6e9331e10d6a96d754a3d6",
"sha256": "aa17aa5ed20e41537fb226a978c2e211ed734913791a24794344b9903bef31ea"
},
"downloads": -1,
"filename": "tdsr-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "714fad004e6e9331e10d6a96d754a3d6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 1961638,
"upload_time": "2023-12-26T17:53:56",
"upload_time_iso_8601": "2023-12-26T17:53:56.391019Z",
"url": "https://files.pythonhosted.org/packages/12/3f/121f20d63b158248ba0efaaebd2f9d37a1e9687ebd0b51a8fb48d09e5f88/tdsr-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-26 17:53:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "torstendahm",
"github_project": "tdsr",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "tdsr"
}
JSON
