diff --git a/Wrap/Python/PyPI_project_description.md b/Wrap/Python/PyPI_project_description.md new file mode 100644 index 0000000000000000000000000000000000000000..e6d19c1ff1eb7d561edd962403a8a634e0093212 --- /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 56de808cc0f5d512d669d8e9c602978d7127fc0a..bbf9b2a5388e110af1bb2eb8158c224fc958f1f6 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