| Name | sympde JSON |
| Version |
0.19.0
JSON |
| download |
| home_page | None |
| Summary | Symbolic calculus for partial differential equations (and variational forms) |
| upload_time | 2024-08-14 11:43:07 |
| maintainer | Said Hadjout |
| docs_url | None |
| author | None |
| requires_python | <3.13,>=3.8 |
| license | MIT License Copyright (c) 2018 Pyccel 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 |
math
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
SymPDE
======
|CI status| |binder| |docs|
**SymPDE** is a symbolic calculus library for partial differential equations and variational forms.
It can be used to have similar capabilities as the fenics_ project, by extending and writing your own *printing* functions.
An example of use can be found in psydac_ or gelato_.
.. _psydac: https://github.com/pyccel/psydac
.. _gelato: https://github.com/pyccel/gelato
.. _fenics: https://fenicsproject.org/
Install
*******
From PyPi
^^^^^^^^^
Simply run, for a local installation::
pip3 install --user sympde
or::
pip3 install sympde
for a global installation.
From sources
^^^^^^^^^^^^
* **Standard mode**::
python3 -m pip install .
* **Development mode**::
python3 -m pip install --user -e .
For developers
**************
Because many important features of SymPDE are only tested in Psydac, new PRs should also be tested against the test suite of Psydac.
This can be done by opening a PR in Psydac, where the only change consists of installing the corresponding branch of SymPDE.
To achieve this, one just needs to modify the line corresponding to ``sympde`` in the ``pyproject.yaml`` file.
For instance, to test a new SymPDE branch called ``my_feature``, one should write
.. code-block:: python
# Our packages from PyPi
'sympde @ https://github.com/pyccel/sympde/archive/refs/heads/my_feature.zip',
Similarly, to test an unreleased version of SymPDE called ``v0.18.4-trunk``, one should write
.. code-block:: python
# Our packages from PyPi
'sympde @ https://github.com/pyccel/sympde/archive/refs/tags/v0.18.4-trunk.zip',
Do not forget the comma at the end of the line, as this is an item in a list.
Also, pay attention to the words ``head`` and ``tags`` in the path: the former is used for Git branches, the latter is used for Git tags (which may or may not correspond to GitHub releases).
.. |CI status| image:: https://github.com/pyccel/sympde/actions/workflows/continuous-integration.yml/badge.svg?branch=master&event=push
:alt: CI status
:target: https://github.com/pyccel/sympde/actions/workflows/continuous-integration.yml
.. |docs| image:: https://readthedocs.org/projects/sympde/badge/?version=latest
:alt: Documentation Status
:target: http://sympde.readthedocs.io/en/latest/?badge=latest
.. |binder| image:: https://mybinder.org/badge_logo.svg
:alt: Run notebooks in Binder
:target: https://mybinder.org/v2/gh/pyccel/sympde/master
Raw data
{
"_id": null,
"home_page": null,
"name": "sympde",
"maintainer": "Said Hadjout",
"docs_url": null,
"requires_python": "<3.13,>=3.8",
"maintainer_email": "Yaman G\u00fc\u00e7l\u00fc <yaman.guclu@gmail.com>",
"keywords": "math",
"author": null,
"author_email": "Ahmed Ratnani <ratnaniahmed@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/4d/d8/a0b23eec18c1729f0be87b920b836ab3f8c868a72a6a263109de44e76984/sympde-0.19.0.tar.gz",
"platform": null,
"description": "SymPDE\n======\n\n|CI status| |binder| |docs|\n\n**SymPDE** is a symbolic calculus library for partial differential equations and variational forms.\nIt can be used to have similar capabilities as the fenics_ project, by extending and writing your own *printing* functions.\n\nAn example of use can be found in psydac_ or gelato_. \n\n.. _psydac: https://github.com/pyccel/psydac\n.. _gelato: https://github.com/pyccel/gelato\n.. _fenics: https://fenicsproject.org/\n\nInstall\n*******\n\nFrom PyPi\n^^^^^^^^^\n\nSimply run, for a local installation::\n\n pip3 install --user sympde \n\nor::\n\n pip3 install sympde \n\nfor a global installation.\n\nFrom sources\n^^^^^^^^^^^^\n\n* **Standard mode**::\n\n python3 -m pip install .\n\n* **Development mode**::\n\n python3 -m pip install --user -e .\n\n\nFor developers\n**************\n\nBecause many important features of SymPDE are only tested in Psydac, new PRs should also be tested against the test suite of Psydac.\nThis can be done by opening a PR in Psydac, where the only change consists of installing the corresponding branch of SymPDE.\nTo achieve this, one just needs to modify the line corresponding to ``sympde`` in the ``pyproject.yaml`` file.\n\nFor instance, to test a new SymPDE branch called ``my_feature``, one should write\n\n.. code-block:: python\n\n # Our packages from PyPi\n 'sympde @ https://github.com/pyccel/sympde/archive/refs/heads/my_feature.zip',\n\nSimilarly, to test an unreleased version of SymPDE called ``v0.18.4-trunk``, one should write\n\n.. code-block:: python\n\n # Our packages from PyPi\n 'sympde @ https://github.com/pyccel/sympde/archive/refs/tags/v0.18.4-trunk.zip',\n\nDo not forget the comma at the end of the line, as this is an item in a list.\nAlso, pay attention to the words ``head`` and ``tags`` in the path: the former is used for Git branches, the latter is used for Git tags (which may or may not correspond to GitHub releases).\n\n\n.. |CI status| image:: https://github.com/pyccel/sympde/actions/workflows/continuous-integration.yml/badge.svg?branch=master&event=push\n :alt: CI status\n :target: https://github.com/pyccel/sympde/actions/workflows/continuous-integration.yml\n\n.. |docs| image:: https://readthedocs.org/projects/sympde/badge/?version=latest\n :alt: Documentation Status\n :target: http://sympde.readthedocs.io/en/latest/?badge=latest\n\n.. |binder| image:: https://mybinder.org/badge_logo.svg\n :alt: Run notebooks in Binder\n :target: https://mybinder.org/v2/gh/pyccel/sympde/master\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2018 Pyccel 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": "Symbolic calculus for partial differential equations (and variational forms)",
"version": "0.19.0",
"project_urls": {
"Repository": "https://github.com/pyccel/sympde"
},
"split_keywords": [
"math"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ffbcb1ae0a056ec0374d66901825acd3bfb31b61d874359e850f2e9b743f90db",
"md5": "8d2c0577de23d23fc44a00c5136b1489",
"sha256": "56361b0c9b112956eca7ea6d9d118552ad6b4e9fa1462db6bd0a353adbb3d19f"
},
"downloads": -1,
"filename": "sympde-0.19.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8d2c0577de23d23fc44a00c5136b1489",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.8",
"size": 123500,
"upload_time": "2024-08-14T11:43:04",
"upload_time_iso_8601": "2024-08-14T11:43:04.868509Z",
"url": "https://files.pythonhosted.org/packages/ff/bc/b1ae0a056ec0374d66901825acd3bfb31b61d874359e850f2e9b743f90db/sympde-0.19.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4dd8a0b23eec18c1729f0be87b920b836ab3f8c868a72a6a263109de44e76984",
"md5": "d97c59ac4fd286f5e20acf6fb3cdc288",
"sha256": "d79a268fda8498b9f33cdb7a328ed3023a7730438fb4a7baa114f68b153eef88"
},
"downloads": -1,
"filename": "sympde-0.19.0.tar.gz",
"has_sig": false,
"md5_digest": "d97c59ac4fd286f5e20acf6fb3cdc288",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.8",
"size": 104099,
"upload_time": "2024-08-14T11:43:07",
"upload_time_iso_8601": "2024-08-14T11:43:07.554224Z",
"url": "https://files.pythonhosted.org/packages/4d/d8/a0b23eec18c1729f0be87b920b836ab3f8c868a72a6a263109de44e76984/sympde-0.19.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-14 11:43:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pyccel",
"github_project": "sympde",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sympde"
}
