##############################################################################
#       Copyright (C) 2016 Sebastian Oehms <s.oehms@web.de>
#
#  Distributed under the terms of the GNU General Public License (GPL)
#
#  The full text of the GPL is available at:
#
#                  http://www.gnu.org/licenses/
##############################################################################

This project is free software in the sense of the GNU General Public License (GPL).

You may use it online via the SageMathCloud or install it to your own equipment if you have sage installed.

1) Using the CubicBraidGroup class in SageMathCloud:

    There are two possibilities to get access to the CubicBraidGroup class

    a) Installing the class into one of your own SageMathCloud projects.

        -- copy the cbg.tgz -file to your SageMathCloud project
        -- open a command line terminal ( or a ssh session ) on this project
        -- type the following 

                tar -xpvf cbg.tgz
                chmod o-w CubicBraidGroup/
                chmod o-x CubicBraidGroup/
                chmod g-w CubicBraidGroup/
                chmod g-x CubicBraidGroup/



        Now, there are three possibilities to use the CubicBraidGroup in your SageMathCloud project:


          A) Using the notebook environment:

              -- Open the "files" menue and than open the directory "CubibBraidGroup".
              -- Click on a "New", "Create" Icon and select the type of notebook you prefer.
              -- Into the first cell of the worksheet you must type
                 from cubic_braid import *
              -- Now, you can use all functionality of the CubicBraidGroup class
              -- For examples see the introduction worksheets
                 introduction.sagws
                 introduction.ipynb

          B) Using the jupyter terminal environment:

              -- Click on a "New", "Create" Icon and select the icon for a terminal
              -- when the terminal is launched type
                 cd CubicBraidGroup
                 sage

              -- if sage has been launched type:

                 sage: from cubic_braid import *
                 sage: 

          C) Using ssh access:

              -- To set up ssh access to your project (in case you don't have done so before) follow the instructions
                 on the "settings"-page inside SageMathCloud
              -- open a command line terminal on your computer and type

                 ssh <your project id>@<hostname>.sagemath.com

                     your project id and the hostname are displayed on the "settings"-page, as well

              -- type 
                 cd CubicBraidGroup
                 sage

              -- if sage has been launched type:

                 sage: from cubic_braid import *
                 sage: 


    b) Getting full access to this project as a collaborator

        -- contact s.oehms@web.de to be added as collaborator
        -- if you are added as collaborator you can open this project in a similar way as your own projects
        -- you can do everything which is described in a) inside this project environment. ssh acces is
          
           ssh b31290a1fcab4b04aae3be9344dc0451@compute1-us.sagemath.com

        -- in addition you may change the files, to post corrections and improvements to the project. 

           in this case: please use git for version control of your changes. Create a new branch with your name (pseudonome)
           and mail your suggestions to "s.oehms@web.de"



2) Installation on your own computer:
    
    You need to have sage installed. This software has been tested under the following versions: 6.9, 7.2, 7.3, 7.5

    There are two possibilities:

      a) Using the tar-file:

          -- Download the cbg.tgz -file into a direktory where you can use sage 
          -- open a command line terminal on your computer and cd to this directory
          -- type the following 
                   tar -xpvf cbg.tgz
                   chmod o-w CubicBraidGroup/
                   chmod o-x CubicBraidGroup/
                   chmod g-w CubicBraidGroup/
                   chmod g-x CubicBraidGroup/
                   cd CubicBraidGroup
                   sage

          -- if sage has been launched do the following test:

             sage: 
             sage: from cubic_braid import *
             sage: C3 = CubicBraidGroup(3)
             sage: TestSuite(C3).run()
             sage: 

      b) Using git

          -- contact s.oehms@web.de to be added as collaborator
          -- if you are added as collaborator you must to set up ssh access to the CubicBraidGroup project site
             following the "settings"-page inside SageMathCloud
          -- open a command line terminal on your computer in a directory where you can use sage
          -- type the following 

             git clone b31290a1fcab4b04aae3be9344dc0451@compute1-us.sagemath.com:~/CubicBraidGroup.git
             cd CubicBraidGroup
             sage

          -- if sage has been launched do the following test:
             sage: 
             sage: from cubic_braid import *
             sage: C3 = CubicBraidGroup(3)
             sage: TestSuite(C3).run()
             sage: 
 
          The installation using git has the adventage that you can push corrections or extensions back to the SageMathCloud.          But if you do that: Please create your own branch to this purpose, push just this branch and send a message to
          "s.oehms@web.de".