Metadata-Version: 2.1
Name: database_knotinfo
Version: 0.7
Summary: Content of the KnotInfo and LinkInfo databases as lists of dictionaries
Home-page: https://github.com/soehms/database_knotinfo
Author: Sebastian Oehms
Author-email: seb.oehms@gmail.com
License: GPL
Description: # Database KnotInfo
        
        This repository contains a snapshot of the complete content of the [KnotInfo](https://knotinfo.math.indiana.edu/) and [LinkInfo](https://linkinfo.sitehost.iu.edu/) databases. It is provided as Python lists of Python dictionaries. These are obtained from the corresponding Excel spreadsheets available on the KnotInfo and LinkInfo hompages on the date of release.
        
        The repository has been created as a part of the [SageMath](https://www.sagemath.org/) interface to theses databases (see Trac ticket [#30352](https://trac.sagemath.org/ticket/30352))  but can also be used independently.
        
        In Python code it can be used in den following way:
        
        ```
        >>> from database_knotinfo import link_list
        >>> k = link_list()
        >>> len(k)
        2979
        >>> names_k = k[0]
        >>> type(names_k)
        <type 'dict'>
        >>> names_k['braid_index']
        'Braid Index'
        >>> k2 = k[2]
        >>> k2['name']
        '3_1'
        >>> k2['braid_index']
        '2'
        >>> k2['homfly_polynomial']
        '(2*v^2-v^4)+(v^2)*z^2'
        
        >>> l = link_list(proper_links=True)
        >>> len(l)
        4189
        >>> names_l = l[0]
        >>> type(names_l)
        <type 'dict'>
        >>> names_l['braid_notation']
        'Braid Notation'
        >>> l2 = l[2]
        >>> l2['name']
        'L2a1{1}'
        >>> l2['homflypt_polynomial']
        'v/z-v^3/z + v*z'
        ```
        
        In order to build a new release, the `CSV` files can be upgraded with the `create_knotinfo_csv.py` script.
        
        ## Installation
        
        
        ### Python
        
        ```
        pip install database_knotinfo
        ```
        
        ### SageMath
        
        Once ticket #30352 will be released the database can be installed in Sage by:
        
        ```
        sage -i database_knotinfo
        ```
        
        This will contain integration with the knot and link functionality of Sage. Of course the flat Python functionality is available before by:
        
        ```
        sage -pip install database_knotinfo
        ```
        
        ## Help
        
        If you note an essential divergence between this repository and the original data please create an issue about that.
        
        ## Credits
        
        Many thanks to Chuck Livingston and Allison Moore for making the data available. For further acknowledgments see the correspondig hompages.
        
Keywords: KnotInfo,LinkInfo,SageMath,database
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
