Metadata-Version: 1.1
Name: sage-combinat-widgets
Version: 0.7.4
Summary: A Custom Jupyter Widget Library
Home-page: https://github.com/sagemath/sage-combinat-widgets
Author: Odile Bénassy, Nicolas M. Thiéry
Author-email: odile.benassy@u-psud.fr
License: GPLv3+
Description: =====================
        Sage Combinat Widgets
        =====================
        
        .. image:: https://mybinder.org/badge.svg
           :target: https://mybinder.org/v2/gh/sagemath/sage-combinat-widgets/master
        
        Jupyter editable widgets for Sagemath combinatorial objects:
        
        - Partition & Skew Partition
        - Standard/Semi-standard/Generic Tableau & Skew Tableau
        
        Also : 
        
        - Matrices
        - grid-representable Graphs
        
        Installation
        ------------
        
        Local install from source
        ^^^^^^^^^^^^^^^^^^^^^^^^^
        
        Download the source from the git repository::
        
            $ git clone https://github.com/sagemath/sage-combinat-widgets.git
        
        Change to the root directory and run::
        
            $ sage -pip install --upgrade --no-index -v .
        
        For convenience this package contains a [makefile](makefile) with this
        and other often used commands. Should you wish too, you can use the
        shorthand::
        
            $ make install
        
        Usage
        -----
        
        Once the package is installed, you can use it in Sage Jupyter Notebook.
        
        
            from sage_combinat_widgets import GridViewWidget
            
            S = StandardTableaux(15).random_element()
            
            w = TableauWidget(t)
            
            w
        
        
        See the `demo notebook <demo_GridViewWidget.ipynb>`_.
        
        Tests
        -----
        
        Once the package is installed, one can use the SageMath test system
        configured in ``setup.py`` to run the tests::
        
            $ sage setup.py test
        
        This is just calling ``sage -t`` with appropriate flags.
        
        Shorthand::
        
            $ make test
        
        Documentation
        -------------
        
        The documentation of the package can be generated using Sage's
        ``Sphinx`` installation::
        
            $ cd docs
            $ sage -sh -c "make html"
        
        Shorthand::
        
            $ make doc
        
Keywords: SageMath,jupyter,widget,combinatorics
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 2.7
