Commit 259f6aeb authored by rnahme's avatar rnahme
Browse files

modified packaging setup

parent 83266eff
#######################################
Welcome to ProxToolbox's documentation!
#######################################
The ProxToolbox is a collection of interfaces and classes for solving mathematical problems using fixed point iterations with proximal operators.
The basic idea is to provide a toolbox-like structure of several modules. Most instances are based on generic interfaces to facilitate generalization and substitutions.
......@@ -3,13 +3,18 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
#######################################
Welcome to ProxToolbox's documentation!
#######################################
.. include:: ../README.md
.. automodule:: proxtoolbox
In the following, we provide a manual for the ProxToolbox. Therefore, we also explain its general idea and structure.
In the following, we provide a manual for the ProxToolbox.
.. toctree::
:maxdepth: 1
......
......@@ -8,7 +8,6 @@
:Copyright: (c) 2015 by D. Russell Luke
:License: BSD, see LICENSE for more details.
:Content: ProxPython is a collection of interfaces and classes for solving mathematical problems using fixed point iterations with proximal operators.
:Contributors:
* Robert Hesse, Inst. for Numerical and Applied Math, Universität Göttingen
* Pär Mattson, Inst. for Numerical and Applied Math, Universität Göttingen (Ptychography)
......@@ -17,10 +16,10 @@
* Matthew Tam, CARMA, University of Newcastle, Australia (Ptychography)
* Robin Wilke, Inst. for X-Ray Physics, Univesität Göttingen (Ptychography and Phase)
* Stefan Ziehe, Inst. for Numerical and Applied Math, Universität Göttingen.
:Funding: This has grown over the years and has been supported in part by:
:Funding: This has grown over the years and has been supported in part by:
* NASA grant NGT5-66
* the Pacific Institute for Mathematical Sciences (PIMS)
* Pacific Institute for Mathematical Sciences (PIMS)
* USA NSF Grant DMS-0712796
* German DFG grant SFB-755 TPC2
......
......@@ -29,10 +29,10 @@ setup(
long_description=long_description,
# The project's main homepage.
url='https://projects.gwdg.de/projects/proxtoolbox/',
url='https://gitlab.gwdg.de/jschulz1/proxtoolbox/',
# Author details
author='Russell Luke, Stefan Ziehe',
author='Russell Luke',
author_email='r.luke@math.uni-goettingen.de',
# Choose your license
......@@ -44,7 +44,7 @@ setup(
# 3 - Alpha
# 4 - Beta
# 5 - Production/Stable
'Development Status :: 3 - Beta',
'Development Status :: 3 - Alpha',
# Indicate who your project is intended for
'Intended Audience :: Scientists',
......@@ -62,11 +62,11 @@ setup(
],
# What does your project relate to?
keywords='ptychography',
keywords=['algorithms', 'proximal operators', 'ptychography', 'sudoku'],
# You can just specify the packages manually here if your project is
# simple. Or you can use find_packages().
packages=find_packages(exclude=['contrib', 'docs', 'tests']),
packages=find_packages(exclude=['contrib', 'docs', 'test*']),
# Alternatively, if you want to distribute just a my_module.py, uncomment
# this:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment