Powered by CoCalc
1
##############################################################################
2
# Copyright (C) 2016 Sebastian Oehms <[email protected]>
3
#
4
# Distributed under the terms of the GNU General Public License (GPL)
5
#
6
# The full text of the GPL is available at:
7
#
8
# http://www.gnu.org/licenses/
9
##############################################################################
10
11
This project is free software in the sense of the GNU General Public License (GPL).
12
13
You may use it online via the SageMathCloud or install it to your own equipment if you have sage installed.
14
15
1) Using the CubicBraidGroup class in SageMathCloud:
16
17
There are two possibilities to get access to the CubicBraidGroup class
18
19
a) Installing the class into one of your own SageMathCloud projects.
20
21
-- copy the cbg.tgz -file to your SageMathCloud project
22
-- open a command line terminal ( or a ssh session ) on this project
23
-- type the following
24
25
tar -xpvf cbg.tgz
26
chmod o-w CubicBraidGroup/
27
chmod o-x CubicBraidGroup/
28
chmod g-w CubicBraidGroup/
29
chmod g-x CubicBraidGroup/
30
31
32
33
Now, there are three possibilities to use the CubicBraidGroup in your SageMathCloud project:
34
35
36
A) Using the notebook environment:
37
38
-- Open the "files" menue and than open the directory "CubibBraidGroup".
39
-- Click on a "New", "Create" Icon and select the type of notebook you prefer.
40
-- Into the first cell of the worksheet you must type
41
from cubic_braid import *
42
-- Now, you can use all functionality of the CubicBraidGroup class
43
-- For examples see the introduction worksheets
44
introduction.sagws
45
introduction.ipynb
46
47
B) Using the jupyter terminal environment:
48
49
-- Click on a "New", "Create" Icon and select the icon for a terminal
50
-- when the terminal is launched type
51
cd CubicBraidGroup
52
sage
53
54
-- if sage has been launched type:
55
56
sage: from cubic_braid import *
57
sage:
58
59
C) Using ssh access:
60
61
-- To set up ssh access to your project (in case you don't have done so before) follow the instructions
62
on the "settings"-page inside SageMathCloud
63
-- open a command line terminal on your computer and type
64
65
ssh <your project id>@<hostname>.sagemath.com
66
67
your project id and the hostname are displayed on the "settings"-page, as well
68
69
-- type
70
cd CubicBraidGroup
71
sage
72
73
-- if sage has been launched type:
74
75
sage: from cubic_braid import *
76
sage:
77
78
79
b) Getting full access to this project as a collaborator
80
81
-- contact [email protected] to be added as collaborator
82
-- if you are added as collaborator you can open this project in a similar way as your own projects
83
-- you can do everything which is described in a) inside this project environment. ssh acces is
84
85
ssh [email protected]
86
87
-- in addition you may change the files, to post corrections and improvements to the project.
88
89
in this case: please use git for version control of your changes. Create a new branch with your name (pseudonome)
90
and mail your suggestions to "[email protected]"
91
92
93
94
2) Installation on your own computer:
95
96
You need to have sage installed. This software has been tested under the following versions: 6.9, 7.2, 7.3, 7.5
97
98
There are two possibilities:
99
100
a) Using the tar-file:
101
102
-- Download the cbg.tgz -file into a direktory where you can use sage
103
-- open a command line terminal on your computer and cd to this directory
104
-- type the following
105
tar -xpvf cbg.tgz
106
chmod o-w CubicBraidGroup/
107
chmod o-x CubicBraidGroup/
108
chmod g-w CubicBraidGroup/
109
chmod g-x CubicBraidGroup/
110
cd CubicBraidGroup
111
sage
112
113
-- if sage has been launched do the following test:
114
115
sage:
116
sage: from cubic_braid import *
117
sage: C3 = CubicBraidGroup(3)
118
sage: TestSuite(C3).run()
119
sage:
120
121
b) Using git
122
123
-- contact [email protected] to be added as collaborator
124
-- if you are added as collaborator you must to set up ssh access to the CubicBraidGroup project site
125
following the "settings"-page inside SageMathCloud
126
-- open a command line terminal on your computer in a directory where you can use sage
127
-- type the following
128
129
git clone [email protected]:~/CubicBraidGroup.git
130
cd CubicBraidGroup
131
sage
132
133
-- if sage has been launched do the following test:
134
sage:
135
sage: from cubic_braid import *
136
sage: C3 = CubicBraidGroup(3)
137
sage: TestSuite(C3).run()
138
sage:
139
140
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
141
"[email protected]".
142
143