| Name | metran JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | |
| Summary | Python package to perform timeseries analysis of multiple hydrological time series using a dynamic factor model. |
| upload_time | 2024-02-20 15:23:51 |
| maintainer | |
| docs_url | None |
| author | W.L. Berendrecht |
| requires_python | >=3.8 |
| license | The MIT License (MIT) Copyright (c) 2021 W.L. Berendrecht Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
hydrology
groundwater
timeseries
analysis
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/pastas/metran/actions/workflows/ci.yml)
[](https://metran.readthedocs.io/en/latest/?badge=latest)
[](https://www.codacy.com/gh/pastas/metran/dashboard?utm_source=github.com&utm_medium=referral&utm_content=pastas/metran&utm_campaign=Badge_Grade)
[](https://www.codacy.com/gh/pastas/metran/dashboard?utm_source=github.com&utm_medium=referral&utm_content=pastas/metran&utm_campaign=Badge_Coverage)
# Metran
Metran is a package for performing multivariate timeseries analysis using a
technique called dynamic factor modelling. It can be used to describe the
variation among many variables in terms of a few underlying but unobserved
variables called factors.
## Documentation
The documention can be found on [metran.readthedocs.io](https://metran.readthedocs.io/)
### Examples
For a brief introduction of the theory behind Metran on multivariate timeseries analysis with
dynamic factor modeling see the notebook:
- [The Dynamic Factor Model](https://github.com/pastas/metran/blob/main/examples/dynamic_factor_model.ipynb)
A practical real-world example, as published in Stromingen (Van Geer, 2015), is given in the following notebook:
- [Metran practical example](https://github.com/pastas/metran/blob/main/examples/metran_practical_example.ipynb)
A notebook on how to use [Pastas](https://github.com/pastas/pastas) models output with Metran:
- [Pastas Metran example](https://github.com/pastas/metran/blob/main/examples/pastas_metran_example.ipynb)
## Installation
To install Metran, a working version of Python 3.8 or higher has to be installed on your computer.
We recommend using the [Anaconda distribution](https://www.anaconda.com/) as it includes most
of the python package dependencies and the Jupyter Notebook software to run the
notebooks. However, you are free to install any Python distribution you want.
To install `metran`, type the following command
`pip install metran`
To install in development mode, clone the repository and type the following from the module root directory:
`pip install -e .`
### Dependencies
Metran has the following dependencies which are automatically installed if
not already available: `numpy`, `scipy`, `pandas`, `matplotlib`, `numba` and `pastas`
## References
- Berendrecht, W.L. (2004). [State space modeling of groundwater fluctuations](https://repository.tudelft.nl/islandora/object/uuid:f12775fc-a804-4d4a-8872-664e5a61cbf5/datastream/OBJ). Doctoral Thesis, Delft University of Technology.
- Berendrecht, W.L., F.C. van Geer (2016). [A dynamic factor modeling framework for analyzing multiple groundwater head series simultaneously](http://dx.doi.org/10.1016/j.jhydrol.2016.02.028). Journal of Hydrology, 536, pp. 50-60.
- Van Geer, F.C. en W.L. Berendrecht (2015) [Meervoudige tijdreeksmodellen en de samenhang in stijghoogtereeksen](https://edepot.wur.nl/378871). Stromingen 23 nummer 3, pp. 25-36.
Raw data
{
"_id": null,
"home_page": "",
"name": "metran",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "\"W.L. Berendrecht\" <wilbert@berendrechtconsultancy.nl>, \"D.A. Brakenhoff\" <d.brakenhoff@artesia-water.nl>, \"M.A. Vonk\" <m.vonk@artesia-water.nl>",
"keywords": "hydrology,groundwater,timeseries,analysis",
"author": "W.L. Berendrecht",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/92/fd/3f443bc58a8c5e838edf12fed9702b4c1b9fd09053098a33549638e08a2d/metran-0.4.0.tar.gz",
"platform": null,
"description": "[](https://github.com/pastas/metran/actions/workflows/ci.yml)\n[](https://metran.readthedocs.io/en/latest/?badge=latest)\n[](https://www.codacy.com/gh/pastas/metran/dashboard?utm_source=github.com&utm_medium=referral&utm_content=pastas/metran&utm_campaign=Badge_Grade)\n[](https://www.codacy.com/gh/pastas/metran/dashboard?utm_source=github.com&utm_medium=referral&utm_content=pastas/metran&utm_campaign=Badge_Coverage)\n\n\n# Metran\n\nMetran is a package for performing multivariate timeseries analysis using a\ntechnique called dynamic factor modelling. It can be used to describe the\nvariation among many variables in terms of a few underlying but unobserved\nvariables called factors.\n\n## Documentation\n\nThe documention can be found on [metran.readthedocs.io](https://metran.readthedocs.io/)\n\n### Examples\n\nFor a brief introduction of the theory behind Metran on multivariate timeseries analysis with\ndynamic factor modeling see the notebook:\n\n- [The Dynamic Factor Model](https://github.com/pastas/metran/blob/main/examples/dynamic_factor_model.ipynb)\n\nA practical real-world example, as published in Stromingen (Van Geer, 2015), is given in the following notebook:\n\n- [Metran practical example](https://github.com/pastas/metran/blob/main/examples/metran_practical_example.ipynb)\n\nA notebook on how to use [Pastas](https://github.com/pastas/pastas) models output with Metran:\n\n- [Pastas Metran example](https://github.com/pastas/metran/blob/main/examples/pastas_metran_example.ipynb)\n\n## Installation\n\nTo install Metran, a working version of Python 3.8 or higher has to be installed on your computer.\nWe recommend using the [Anaconda distribution](https://www.anaconda.com/) as it includes most\nof the python package dependencies and the Jupyter Notebook software to run the\nnotebooks. However, you are free to install any Python distribution you want.\n\nTo install `metran`, type the following command\n\n`pip install metran`\n\nTo install in development mode, clone the repository and type the following from the module root directory:\n\n`pip install -e .`\n\n### Dependencies\n\nMetran has the following dependencies which are automatically installed if\nnot already available: `numpy`, `scipy`, `pandas`, `matplotlib`, `numba` and `pastas`\n\n## References\n\n- Berendrecht, W.L. (2004). [State space modeling of groundwater fluctuations](https://repository.tudelft.nl/islandora/object/uuid:f12775fc-a804-4d4a-8872-664e5a61cbf5/datastream/OBJ). Doctoral Thesis, Delft University of Technology.\n- Berendrecht, W.L., F.C. van Geer (2016). [A dynamic factor modeling framework for analyzing multiple groundwater head series simultaneously](http://dx.doi.org/10.1016/j.jhydrol.2016.02.028). Journal of Hydrology, 536, pp. 50-60.\n- Van Geer, F.C. en W.L. Berendrecht (2015) [Meervoudige tijdreeksmodellen en de samenhang in stijghoogtereeksen](https://edepot.wur.nl/378871). Stromingen 23 nummer 3, pp. 25-36.\n",
"bugtrack_url": null,
"license": "The MIT License (MIT) Copyright (c) 2021 W.L. Berendrecht Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Python package to perform timeseries analysis of multiple hydrological time series using a dynamic factor model.",
"version": "0.4.0",
"project_urls": {
"documentation": "https://metran.readthedocs.io/en/latest/",
"homepage": "https://github.com/pastas/metran",
"repository": "https://github.com/pastas/metran"
},
"split_keywords": [
"hydrology",
"groundwater",
"timeseries",
"analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a3d3bf53497d13294e37f569609f2d444af6e9d5e61895769c3b16c5f908f3db",
"md5": "c1a21a62cf161f6756a0e66c0d2ecf2b",
"sha256": "4dbc098b8516d004bb3e80efd9aca78e28ea50697cb97b12c6b1c201da1fd866"
},
"downloads": -1,
"filename": "metran-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c1a21a62cf161f6756a0e66c0d2ecf2b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 29427,
"upload_time": "2024-02-20T15:23:49",
"upload_time_iso_8601": "2024-02-20T15:23:49.497187Z",
"url": "https://files.pythonhosted.org/packages/a3/d3/bf53497d13294e37f569609f2d444af6e9d5e61895769c3b16c5f908f3db/metran-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "92fd3f443bc58a8c5e838edf12fed9702b4c1b9fd09053098a33549638e08a2d",
"md5": "06c3630a43da2b6b57ed04b68251b753",
"sha256": "08b291f4f7775779719ce0978338ab9609103dc65d1bbd8cc56724c6420ec84b"
},
"downloads": -1,
"filename": "metran-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "06c3630a43da2b6b57ed04b68251b753",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 30754,
"upload_time": "2024-02-20T15:23:51",
"upload_time_iso_8601": "2024-02-20T15:23:51.303175Z",
"url": "https://files.pythonhosted.org/packages/92/fd/3f443bc58a8c5e838edf12fed9702b4c1b9fd09053098a33549638e08a2d/metran-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-20 15:23:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pastas",
"github_project": "metran",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "metran"
}
