diff --git a/CHANGELOG.md b/CHANGELOG.md index 869e6cbdb33f03b2a18f49c7b5f28882e028e509..51a0c8ce1c458250087a9ac8a668dbad48a9ab37 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,12 @@ :arrow_left: [Back to main page](./README.md) +- January 23, 2023: Version 5.1 brings a lot of changes to the documentation, both on Github and on the website. + We revived the [codecov](https://app.codecov.io/gh/Parallel-in-Time/pySDC) connection and started the + [OpenSFF Best Practices](https://bestpractices.coreinfrastructure.org/en/projects/6909) guide. + The hook classes and the way they are handled has changed (without breaking the API, hooray), the battery model + got quite an update and adaptivity plays a more prominent role now. Thanks to [\@brownbaerchen](https://github.com/brownbaerchen), + [\@tlunet](https://github.com/tlunet), [\@lisawim](https://github.com/lisawim)! - October 7, 2022: Version 5 comes with many changes, both visible and invisible ones. Some of those break the existing API, but if you are using tests, you should be fine. Major changes include: diff --git a/CITATION.cff b/CITATION.cff index 1cd4e3f455cb72d111bde0b90a6e41ba1224ca55..14878b08c6df2b47851801e865b64f338cdeb3e6 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -2,13 +2,25 @@ abstract: "The pySDC project is a Python implementation of the spectral deferred authors: - family-names: Speck given-names: Robert - orcid: https://orcid.org/https://orcid.org/0000-0002-3879-1210 + orcid: https://orcid.org/0000-0002-3879-1210 affiliation: "Jülich Supercomputing Centre, Forschungszentrum Jülich GmbH, 52425 Jülich, Germany" + - family-names: Lunet + given-names: Thibaut + orcid: https://orcid.org/0000-0003-1745-0780 + affiliation: "Hamburg University of Technology, Institute of Mathematics, 21073 Hamburg, Germany" + - family-names: Baumann + given-names: Thomas + orcid: https://orcid.org/0000-0002-4676-7659 + affiliation: "Jülich Supercomputing Centre, Forschungszentrum Jülich GmbH, 52425 Jülich, Germany" + - family-names: Wimmer + given-names: Lisa + orcid: https://orcid.org/0000-0001-8829-0978 + affiliation: "University of Wuppertal, School of Mathematics and Natural Science, 42119 Wuppertal, Germany" cff-version: 1.2.0 -date-released: 2022-10-07 +date-released: 2023-01-23 doi: 10.5281/zenodo.5599144 keywords: - - "parallel-in-time integration" + - "parallel-in-time" - "spectral deferred corrections" - "parallel full approximation scheme in space and time" - multigrid @@ -17,4 +29,4 @@ license: BSD-2-Clause message: "If you use this software, please cite it using these metadata." repository-code: https://github.com/Parallel-in-Time/pySDC title: "Parallel-in-Time/pySDC" -version: 5.0.0 +version: 5.1.0 diff --git a/LICENSE b/LICENSE index d5d904d990fc97bb3f770e24c1469055a5fc02e7..14e5616410aecbf22aff21e2bb9eba2222a94ac7 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2022, Parallel-in-Time (PinT) Algorithms +Copyright (c) 2023, Parallel-in-Time (PinT) Algorithms All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/MANIFEST.in b/MANIFEST.in index 5afbbd0a76053c678a5a1a06698d605d573284ad..64b651061456bd17d4f2409b944e5e53863fd93d 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,20 +1,24 @@ -# added by check_manifest.py +# added by check-manifest +include *.cff +include *.in include *.md -include *.txt -include *.rst -include Doxyfile +include *.yml include LICENSE include data/README -include *.cff include pyproject.toml - recursive-include docs *.bat +recursive-include docs *.css +recursive-include docs *.jpg +recursive-include docs *.json +recursive-include docs *.md +recursive-include docs *.png recursive-include docs *.py recursive-include docs *.rst recursive-include docs *.sh recursive-include docs Makefile +recursive-include etc *.yml recursive-include pySDC *.npy recursive-include pySDC *.npz recursive-include pySDC *.pkl recursive-include pySDC *.rst -recursive-include pySDC *.txt +recursive-include pySDC *.txt \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 7b095fda0469f64fb241df05671f869ecf232163..222812e4b4c3a219b6ce1a48591bea944e49952d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -62,7 +62,7 @@ master_doc = 'index' # General information about the project. project = 'pySDC' -copyright = '2022, Robert Speck' +copyright = '2023, Robert Speck' author = 'Robert Speck' # The version info for the project you're documenting, acts as replacement for @@ -70,9 +70,9 @@ author = 'Robert Speck' # built documents. # # The short X.Y version. -version = '5.0' +version = '5.1' # The full version, including alpha/beta/rc tags. -release = '5.0.0' +release = '5.1.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/pyproject.toml b/pyproject.toml index 8de669e99d019a9b84da8d2fb18af5a04a8b8979..72a7f8c1d8b8cfe5e43dfb8f15c0d73c1947229f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,12 +4,15 @@ build-backend = "flit_core.buildapi" [project] name = 'pySDC' -version = '5.0.0' +version = '5.1.0' description = 'A Python implementation of spectral deferred correction methods and the likes' license = {text = "BSD-2-Clause"} -readme = 'README.rst' +readme = 'README.md' authors=[ {name='Robert Speck', email='r.speck@fz-juelich.de'}, + {name='Thibaut Lunet', email='thibaut.lunet@tuhh.de'}, + {name='Thomas Baumann', email='t.baumann@fz-juelich.de'}, + {name='Lisa Wimmer', email='wimmer@uni-wuppertal.de'}, ] homepage = "http://www.parallel-in-time.org/pySDC/" repository = "https://github.com/Parallel-in-Time/pySDC/"