From 66b8837181fd50b13a7fac739a4d2407d070e793 Mon Sep 17 00:00:00 2001 From: "Joachim Wuttke (o)" <j.wuttke@fz-juelich.de> Date: Tue, 7 May 2024 15:32:52 +0200 Subject: [PATCH] + Wrap/Python/PyPI_project_description.md (#577) This resolves #577 --- Wrap/Python/PyPI_project_description.md | 24 ++++++++++++++++++++++++ Wrap/Python/setup.cfg.in | 2 +- 2 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 Wrap/Python/PyPI_project_description.md diff --git a/Wrap/Python/PyPI_project_description.md b/Wrap/Python/PyPI_project_description.md new file mode 100644 index 00000000000..e6d19c1ff1e --- /dev/null +++ b/Wrap/Python/PyPI_project_description.md @@ -0,0 +1,24 @@ +BornAgain is a software to simulate and fit neutron and x-ray +reflectometry and scattering at grazing incidence (GISANS and GISAXS), +using the distorted-wave Born approximation (DWBA). + +This Python wheel contains the BornAgain Python module, which +is built on top of the BornAgain C++ core. This is all what is +needed to use BornAgain through its Python API. + +If the BornAgain GUI shall also be used, then another installation +method must be chosen, see the +[BornAgain installation instructions](https://bornagainproject.org/latest/installation). + +#### Homepage +https://www.bornagainproject.org + +#### Copyright +[Forschungszentrum Jülich GmbH](http://www.fz-juelich.de) 2013- + +#### License +GNU General Public License v3 or higher +(see [COPYING](https://jugit.fz-juelich.de/mlz/bornagain/-/blob/main/COPYING)) + +### Citation +See [CITATION](https://jugit.fz-juelich.de/mlz/bornagain/-/blob/main/CITATION)) diff --git a/Wrap/Python/setup.cfg.in b/Wrap/Python/setup.cfg.in index 56de808cc0f..bbf9b2a5388 100644 --- a/Wrap/Python/setup.cfg.in +++ b/Wrap/Python/setup.cfg.in @@ -31,7 +31,7 @@ author = Scientific Computing Group, Forschungszentrum Jülich, MLZ, Garching author_email = contact@bornagainproject.org description = Open-source research software to simulate and fit neutron and x-ray reflectometry and grazing-incidence small-angle scattering. long_description_content_type = text/markdown -long_description = file: README.md, CITATION +long_description = file: Wrap/Python/PyPI_project_description.md, CITATION license = GNU General Public License license_files = COPYING url = https://www.bornagainproject.org -- GitLab