[](https://doi.org/10.5281/zenodo.5758979)
[](https://mybinder.org/v2/gh/MAfarrag/serapis/master)
[](https://img.shields.io/pypi/pyversions/serapis)
[](https://serapis.readthedocs.io/en/latest/?badge=latest)
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://github.com/pre-commit/pre-commit)
[](https://lgtm.com/projects/g/MAfarrag/serapis/context:python)
[](https://github.com/MShawon/github-clone-count-badge) [](https://saythanks.io/to/MAfarrag)
Current build status
====================
<table><tr><td>All platforms:</td>
<td>
<a href="https://dev.azure.com/conda-forge/feedstock-builds/_build/latest?definitionId=12419&branchName=master">
<img src="https://dev.azure.com/conda-forge/feedstock-builds/_apis/build/status/serapis-feedstock?branchName=master">
</a>
</td>
</tr>
</table>
[](https://ci.appveyor.com/project/MAfarrag/serapis)
[](https://codecov.io/gh/Serapieum-of-alex/serapis)
[](https://GitHub.com/Naereen/StrapDown.js/releases/)
Current release info
====================
| Name | Downloads | Version | Platforms |
| --- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| --- | --- |
| [](https://anaconda.org/conda-forge/serapis) | [](https://anaconda.org/conda-forge/serapis) [](https://pepy.tech/project/serapis-nile) [](https://pepy.tech/project/serapis-nile) [](https://pepy.tech/project/serapis-nile)   | [](https://anaconda.org/conda-forge/serapis) [](https://badge.fury.io/py/serapis) [](https://anaconda.org/conda-forge/serapis) | [](https://anaconda.org/conda-forge/serapis) [](https://gitter.im/serapis/serapis?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
 
serapis - Hydrological library for Python
=====================================================================
**serapis** is an open-source Python Framework for building raster-based conceptual distributed hydrological models using HBV96 lumped
model & Muskingum routing method at a catchment scale (Farrag & Corzo, 2021), serapis gives a high degree of flexibility to all components of the model
(spatial discretization - cell size, temporal resolution, parameterization approaches and calibration (Farrag et al., 2021)).
 
serapis
Installing serapis
===============
Installing `serapis` from the `conda-forge` channel can be achieved by:
```
conda install -c conda-forge serapis
```
It is possible to list all of the versions of `serapis` available on your platform with:
```
conda search serapis --channel conda-forge
```
## Install from Github
to install the last development to time you can install the library from github
```
pip install git+https://github.com/MAfarrag/serapis
```
## pip
to install the last release you can easly use pip
```
pip install serapis==0.1.0
```
Quick start
===========
```
>>> import serapis
```
[other code samples](https://serapis.readthedocs.io/en/latest/?badge=latest)
## Naming Convention
[PEP8](https://peps.python.org/pep-0008/#naming-conventions)
- module names: lower case word, preferably one word if not, separate words with underscores (module.py, my_module.py).
- class names: PascalCase (Model, MyClass).
- class method/function: CamelCase(getFile, readConfig).should have a verb one them, because they perform some action
=======
History
=======
0.1.0 (2022-12-26)
------------------
* separate the hydrodynamic model from Hapi package.
Raw data
{
"_id": null,
"home_page": "https://github.com/MAfarrag/serapis",
"name": "serapis",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Hydraulics,Flood model,Inundation model",
"author": "Mostafa Farrag",
"author_email": "moah.farag@gmail.come",
"download_url": "https://files.pythonhosted.org/packages/53/75/a870b5081db04ddff3b8ceceb69d7bfc84134a17e2db4579826a89b113b4/serapis-0.1.0.tar.gz",
"platform": null,
"description": "\n[](https://doi.org/10.5281/zenodo.5758979)\n[](https://mybinder.org/v2/gh/MAfarrag/serapis/master)\n[](https://img.shields.io/pypi/pyversions/serapis)\n[](https://serapis.readthedocs.io/en/latest/?badge=latest)\n[](https://www.gnu.org/licenses/gpl-3.0)\n[](https://github.com/pre-commit/pre-commit)\n[](https://lgtm.com/projects/g/MAfarrag/serapis/context:python)\n\n\n[](https://github.com/MShawon/github-clone-count-badge) [](https://saythanks.io/to/MAfarrag)\n\nCurrent build status\n====================\n\n\n<table><tr><td>All platforms:</td>\n <td>\n <a href=\"https://dev.azure.com/conda-forge/feedstock-builds/_build/latest?definitionId=12419&branchName=master\">\n <img src=\"https://dev.azure.com/conda-forge/feedstock-builds/_apis/build/status/serapis-feedstock?branchName=master\">\n </a>\n </td>\n </tr>\n</table>\n\n[](https://ci.appveyor.com/project/MAfarrag/serapis)\n[](https://codecov.io/gh/Serapieum-of-alex/serapis)\n\n\n\n\n\n\n[](https://GitHub.com/Naereen/StrapDown.js/releases/)\n\n\n\n\nCurrent release info\n====================\n\n| Name | Downloads | Version | Platforms |\n| --- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| --- | --- |\n| [](https://anaconda.org/conda-forge/serapis) | [](https://anaconda.org/conda-forge/serapis) [](https://pepy.tech/project/serapis-nile) [](https://pepy.tech/project/serapis-nile) [](https://pepy.tech/project/serapis-nile)   | [](https://anaconda.org/conda-forge/serapis) [](https://badge.fury.io/py/serapis) [](https://anaconda.org/conda-forge/serapis) | [](https://anaconda.org/conda-forge/serapis) [](https://gitter.im/serapis/serapis?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |\n\n\n \n\n\nserapis - Hydrological library for Python\n=====================================================================\n**serapis** is an open-source Python Framework for building raster-based conceptual distributed hydrological models using HBV96 lumped\nmodel & Muskingum routing method at a catchment scale (Farrag & Corzo, 2021), serapis gives a high degree of flexibility to all components of the model\n(spatial discretization - cell size, temporal resolution, parameterization approaches and calibration (Farrag et al., 2021)).\n\n\n \n\nserapis\n\n\nInstalling serapis\n===============\n\nInstalling `serapis` from the `conda-forge` channel can be achieved by:\n\n```\nconda install -c conda-forge serapis\n```\n\nIt is possible to list all of the versions of `serapis` available on your platform with:\n\n```\nconda search serapis --channel conda-forge\n```\n\n## Install from Github\nto install the last development to time you can install the library from github\n```\npip install git+https://github.com/MAfarrag/serapis\n```\n\n## pip\nto install the last release you can easly use pip\n```\npip install serapis==0.1.0\n```\n\nQuick start\n===========\n\n```\n >>> import serapis\n```\n\n[other code samples](https://serapis.readthedocs.io/en/latest/?badge=latest)\n\n## Naming Convention\n[PEP8](https://peps.python.org/pep-0008/#naming-conventions)\n- module names: lower case word, preferably one word if not, separate words with underscores (module.py, my_module.py).\n- class names: PascalCase (Model, MyClass).\n- class method/function: CamelCase(getFile, readConfig).should have a verb one them, because they perform some action\n\n\n=======\nHistory\n=======\n\n0.1.0 (2022-12-26)\n------------------\n\n* separate the hydrodynamic model from Hapi package.\n",
"bugtrack_url": null,
"license": "GNU General Public License v3",
"summary": "Flood simulation model",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/MAfarrag/serapis"
},
"split_keywords": [
"hydraulics",
"flood model",
"inundation model"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bdbeae81c2862dbb3f89c1427868c6250d777c665ad6c591f68ea7166b2b92ac",
"md5": "3f41896152bad4a469a6c2934ce009b7",
"sha256": "62e43f052d97fc7352217c037ed0259c0eade89bfe3e18213897acdd8b5e1bdb"
},
"downloads": -1,
"filename": "serapis-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3f41896152bad4a469a6c2934ce009b7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 108197,
"upload_time": "2024-01-02T22:54:20",
"upload_time_iso_8601": "2024-01-02T22:54:20.397967Z",
"url": "https://files.pythonhosted.org/packages/bd/be/ae81c2862dbb3f89c1427868c6250d777c665ad6c591f68ea7166b2b92ac/serapis-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5375a870b5081db04ddff3b8ceceb69d7bfc84134a17e2db4579826a89b113b4",
"md5": "8ce88917833fc01b5390ccee8c812adc",
"sha256": "41e48a86e869c9d266e378151acfdee5ff8e17aefe4cd526e24989a0e17fe438"
},
"downloads": -1,
"filename": "serapis-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "8ce88917833fc01b5390ccee8c812adc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 107246,
"upload_time": "2024-01-02T22:54:22",
"upload_time_iso_8601": "2024-01-02T22:54:22.256131Z",
"url": "https://files.pythonhosted.org/packages/53/75/a870b5081db04ddff3b8ceceb69d7bfc84134a17e2db4579826a89b113b4/serapis-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-02 22:54:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MAfarrag",
"github_project": "serapis",
"github_not_found": true,
"lcname": "serapis"
}
JSON
