Skip to content

Commit

Permalink
Version 0.19.0 (#165)
Browse files Browse the repository at this point in the history
* Improve developers' section of `README.rst`
* Remove broken `build status` badge
* Add new `CI status` badge which points to the workflows on the
`master` branch
* Remove obsolete `.travis.yml` configuration file
* Increase library version to 0.19.0 in `pyproject.toml`
  • Loading branch information
yguclu authored Aug 12, 2024
1 parent 62d154f commit 3a9e4b2
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 47 deletions.
26 changes: 0 additions & 26 deletions .travis.yml

This file was deleted.

45 changes: 25 additions & 20 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
sympde
SymPDE
======

|build-status| |binder| |docs|
|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.
**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_.

Expand Down Expand Up @@ -42,33 +43,37 @@ From sources
For developers
**************

Because many important features of sympde are only tested in psydac, new PRs
must 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.
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``, the following
lines can be used in the file ``.github/workflows/continuous-integration.yml`` of psydac:
For instance, to test a new SymPDE branch called ``my_feature``, one should write

.. code-block:: YAML
.. code-block:: python
- name: Download a development version of sympde
working-directory: /tmp
run: |
wget https://github.com/pyccel/sympde/archive/refs/heads/my_feature.zip
unzip ./my_feature.zip
python3 -m pip install ./sympde-my_feature
# 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

.. |build-status| image:: https://travis-ci.com/pyccel/sympde.svg?branch=master
:alt: build status
.. 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
:scale: 100%
:target: https://travis-ci.com/pyccel/sympde
:target: https://github.com/pyccel/sympde/actions/workflows/continuous-integration.yml

.. |docs| image:: https://readthedocs.org/projects/sympde/badge/?version=latest
:alt: Documentation Status
:scale: 100%
:target: http://sympde.readthedocs.io/en/latest/?badge=latest

.. |binder| image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/pyccel/sympde/master
:target: https://mybinder.org/v2/gh/pyccel/sympde/master
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "sympde"
version = "0.18.4"
version = "0.19.0"
description = "Symbolic calculus for partial differential equations (and variational forms)"
readme = "README.rst"
requires-python = ">= 3.8, < 3.13"
Expand Down

0 comments on commit 3a9e4b2

Please sign in to comment.