Metadata-Version: 2.1
Name: examplecurves
Version: 0.2a1
Summary: Module for providing exemplary, reproducible curves for testing and debugging.
Home-page: https://gitlab.com/david.scheliga/examplecurves
Author: David Scheliga
Author-email: david.scheliga@ivw.uni-kl.de
License: GNU General Public License v3 (GPLv3)
Project-URL: Documentation, https://examplecurves.readthedocs.io/en/latest/
Project-URL: Source Code Repository, https://gitlab.com/david.scheliga/examplecurves
Description: # examplecurves
        
        **examplecurves** is a module outsourced from 
        [arithmeticmeancurves](https://gitlab.com/david.scheliga/arithmeticmeancurve).
        Its main purpose is to provide exemplary families of curves for testing and 
        debugging purposes.
        
        ![examplecurves-icon](https://examplecurves.readthedocs.io/en/latest/_images/examplecurves-icon.svg)
        
        ## Installation
        
        ```` shell script
            $ pip install examplecurves
        ````
        
        If available the latest development state can be installed from gitlab.
        
        ```` shell script
            $ pip install git+https://gitlab.com/david.scheliga/examplecurves.git@dev
        ````
        
        ## Alpha Development Status
        
        The current development state of this project is *alpha*. Towards the beta
        
        - naming of modules, classes and methods will change, since the final wording is not
          done.
        - Code inspections are not finished.
        - The documentation is broad or incomplete.
        - Testing is not complete, as it is added during the first test phase. At this
          state mostly doctests are applied at class or function level.
        
        
        ## Basic Usage
        
        [Read-the-docs](https://examplecurves.readthedocs.io/en/latest/index.html) for a more detailed documentation.
        
        ## Contribution
        
        Any contribution by reporting a bug or desired changes are welcomed. The preferred 
        way is to create an issue on the gitlab's project page, to keep track of everything 
        regarding this project.
        
        ### Contribution of Source Code
        #### Code style
        This project follows the recommendations of [PEP8](https://www.python.org/dev/peps/pep-0008/).
        The project is using [black](https://github.com/psf/black) as the code formatter.
        
        #### Workflow
        
        1. Fork the project on Gitlab.
        2. Commit changes to your own branch.
        3. Submit a **pull request** from your fork's branch to our branch *'dev'*.
        
        ## Authors
        
        * **David Scheliga** 
            [@gitlab](https://gitlab.com/david.scheliga)
            [@Linkedin](https://www.linkedin.com/in/david-scheliga-576984171/)
            - Initial work
            - Maintainer
        
        ## License
        
        This project is licensed under the GNU GENERAL PUBLIC LICENSE - see the
        [LICENSE](LICENSE) file for details
        
        ## Acknowledge
        
        [Code style: black](https://github.com/psf/black)
        
Keywords: curve,testing,debugging,engineering
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
