Setup: Difference between revisions

From Knot Atlas
Jump to navigationJump to search
No edit summary
No edit summary
(29 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Manual TOC Sidebar}}
{{Manual TOC Sidebar}}


Start by downloading either the file [http://katlas.math.toronto.edu/KnotTheory/KnotTheory.tar.gz <tt>KnotTheory.tar.gz</tt>] or the file [http://katlas.math.toronto.edu/KnotTheory/KnotTheory.zip <tt>KnotTheory.zip</tt>] (around 1MB each), and unpack either one. This will create a subdirectory KnotTheory/ in your current working directory. This done, no installation is required (though you may wish to check out [[#Further Data Files|Further Data Files]] below). Start Mathematica and you're ready to go:
Start by downloading either the file [http://katlas.org/svn/KnotTheory/tags/stable/KnotTheory.tar.gz <tt>KnotTheory.tar.gz</tt>] or the file [http://katlas.org/svn/KnotTheory/tags/stable/KnotTheory.zip <tt>KnotTheory.zip</tt>] (around 3MB each), and unpack either one. This will create a subdirectory KnotTheory/ in your current working directory. This done, no installation is required (though you may wish to check out [[#Further Data Files|Further Data Files]] and/or [[#Setting the Path|Setting the Path]] below). Start Mathematica and you're ready to go:


<!--$$<< KnotTheory`$$-->
<!--$$<< KnotTheory`$$-->
<!--Robot Land, no human edits to "END"-->
<!--Robot Land, no human edits to "END"-->
<tt><font color=blue>In[1]:=</font></tt><code> << KnotTheory`</code>
<tt><font color=blue>In[2]:=</font></tt><code> << KnotTheory`</code>


<tt>Loading KnotTheory` (version of February 16, 2006, 19:56:47.7317)...</tt>
<tt>Loading KnotTheory` version of March 22, 2011, 21:10:4.67737.
Read more at http://katlas.org/wiki/KnotTheory.</tt>
<!--END-->
<!--END-->


Line 17: Line 18:
<!--Robot Land, no human edits to "END"-->
<!--Robot Land, no human edits to "END"-->
{{InOut|
{{InOut|
n = 2 |
n = 3 |
in = <nowiki>Alexander[Knot[6, 2]][t]</nowiki> |
in = <nowiki>Alexander[Knot[6, 2]][t]</nowiki> |
out= <nowiki> -2 3 2
out= <nowiki> -2 3 2
Line 27: Line 28:
<!--Robot Land, no human edits to "END"-->
<!--Robot Land, no human edits to "END"-->
{{HelpLine|
{{HelpLine|
n = 3 |
n = 4 |
in = <nowiki>KnotTheoryVersion</nowiki> |
in = <nowiki>KnotTheoryVersion</nowiki> |
out= <nowiki>KnotTheoryVersion[] returns the date of the current version of the package KnotTheory`. KnotTheoryVersion[k] returns the kth field in KnotTheoryVersion[].</nowiki>}}
out= <nowiki>KnotTheoryVersion[] returns the date of the current version of the
package KnotTheory`. KnotTheoryVersion[k] returns the kth field in
KnotTheoryVersion[].</nowiki>}}
<!--END-->
<!--END-->


Line 35: Line 38:
<!--Robot Land, no human edits to "END"-->
<!--Robot Land, no human edits to "END"-->
{{HelpLine|
{{HelpLine|
n = 4 |
n = 5 |
in = <nowiki>KnotTheoryVersionString</nowiki> |
in = <nowiki>KnotTheoryVersionString</nowiki> |
out= <nowiki>KnotTheoryVersionString[] returns a string containing the date and time of the current version of the package KnotTheory`. It is generated from KnotTheoryVersion[].</nowiki>}}
out= <nowiki>KnotTheoryVersionString[] returns a string containing the date and
time of the current version of the package KnotTheory`. It is generated
from KnotTheoryVersion[].</nowiki>}}
<!--END-->
<!--END-->


Line 43: Line 48:
<!--Robot Land, no human edits to "END"-->
<!--Robot Land, no human edits to "END"-->
{{HelpLine|
{{HelpLine|
n = 5 |
n = 6 |
in = <nowiki>KnotTheoryWelcomeMessage</nowiki> |
in = <nowiki>KnotTheoryWelcomeMessage</nowiki> |
out= <nowiki>KnotTheoryWelcomeMessage[] returns a string containing the welcome message printed when KnotTheory` is first loaded.</nowiki>}}
out= <nowiki>KnotTheoryWelcomeMessage[] returns a string containing the welcome message
printed when KnotTheory` is first loaded.</nowiki>}}
<!--END-->
<!--END-->


Line 53: Line 59:
<!--Robot Land, no human edits to "END"-->
<!--Robot Land, no human edits to "END"-->
{{InOut|
{{InOut|
n = 6 |
n = 7 |
in = <nowiki>{KnotTheoryVersion[], KnotTheoryVersionString[]}</nowiki> |
in = <nowiki>{KnotTheoryVersion[], KnotTheoryVersionString[]}</nowiki> |
out= <nowiki>{{2006, 2, 16, 19, 56, 47.7317}, February 16, 2006, 19:56:47.7317}</nowiki>}}
out= <nowiki>{{2011, 3, 22, 21, 10, 4.67737}, March 22, 2011, 21:10:4.67737}</nowiki>}}
<!--END-->
<!--END-->


Line 61: Line 67:
<!--Robot Land, no human edits to "END"-->
<!--Robot Land, no human edits to "END"-->
{{InOut|
{{InOut|
n = 7 |
n = 8 |
in = <nowiki>KnotTheoryWelcomeMessage[]</nowiki> |
in = <nowiki>KnotTheoryWelcomeMessage[]</nowiki> |
out= <nowiki>Loading KnotTheory` (version of February 16, 2006, 19:56:47.7317)...</nowiki>}}
out= <nowiki>Loading KnotTheory` version of March 22, 2011, 21:10:4.67737.
Read more at http://katlas.org/wiki/KnotTheory.</nowiki>}}
<!--END-->
<!--END-->


Line 69: Line 76:
<!--Robot Land, no human edits to "END"-->
<!--Robot Land, no human edits to "END"-->
{{HelpLine|
{{HelpLine|
n = 8 |
n = 9 |
in = <nowiki>KnotTheoryDirectory</nowiki> |
in = <nowiki>KnotTheoryDirectory</nowiki> |
out= <nowiki>KnotTheoryDirectory[] returns the best guess KnotTheory` has for its location on the host computer. It can be reset by the user.</nowiki>}}
out= <nowiki>KnotTheoryDirectory[] returns the best guess KnotTheory` has for its
location on the host computer. It can be reset by the user.</nowiki>}}
<!--END-->
<!--END-->


Line 77: Line 85:
<!--Robot Land, no human edits to "END"-->
<!--Robot Land, no human edits to "END"-->
{{InOut|
{{InOut|
n = 9 |
n = 10 |
in = <nowiki>KnotTheoryDirectory[]</nowiki> |
in = <nowiki>KnotTheoryDirectory[]</nowiki> |
out= <nowiki>C:/drorbn/projects/KAtlas/\KnotTheory</nowiki>}}
out= <nowiki>C:\Documents and Settings\pc\Documenti\Wolfram\KnotTheory</nowiki>}}
<!--END-->
<!--END-->


Line 89: Line 97:
<code>KnotTheory`</code> comes with a certain amount of precomputed data which is loaded "on demand" just when it is needed. When a precomputed data file is read by KnotTheory`, a notification message is displayed. To prevent these messages from appearing execute the command <code>Off[KnotTheory::loading]</code>.
<code>KnotTheory`</code> comes with a certain amount of precomputed data which is loaded "on demand" just when it is needed. When a precomputed data file is read by KnotTheory`, a notification message is displayed. To prevent these messages from appearing execute the command <code>Off[KnotTheory::loading]</code>.


====Further Data Files====
====Further Data Files==== To access the Hoste-Thistlethwaite enumeration of knots with 12 to 16 crossings (see [[Naming and Enumeration]]), also download either the file [http://katlas.math.toronto.edu/KnotTheory/DTCodes4Knots12To16.tar.gz <tt>DTCodes4Knots12To16.tar.gz</tt>] or the file [http://katlas.math.toronto.edu/KnotTheory/DTCodes4Knots12To16.zip <tt>DTCodes4Knots12To16.zip</tt>] (about 9MB each), and unpack either one into the directory <tt>KnotTheory/</tt>.
To access the Hoste-Thistlethwaite enumeration of knots with 12 to 16 crossings (see [[Naming and Enumeration]]), also download either the file [http://katlas.org/svn/KnotTheory/tags/stable/DTCodes4Knots12To16.tar.gz <tt>DTCodes4Knots12To16.tar.gz</tt>] or the file [http://katlas.org/svn/KnotTheory/tags/stable/DTCodes4Knots12To16.zip <tt>DTCodes4Knots12To16.zip</tt>] (about 9MB each), and unpack either one into the directory <tt>KnotTheory/</tt>.

====Setting the Path====
The directions above are written on the assumption that the package <tt>KnotTheory`</tt> (more precisely, the directory <tt>KnotTheory/</tt> containing the files that make this package), is somewhere on your Mathematica search path. Usually this will be the case if <tt>KnotTheory/</tt> is a subdirectory of your current working directory. If for some reason Mathematica cannot find <tt>KnotTheory`</tt>, you may tell it where to look in either of the following three ways. Assume <tt>KnotTheory/</tt> is a subdirectory of <tt>FullPathToKnotTheory</tt>:
# If you are using <tt>KnotTheory`</tt> rarely and you don't want to change system defaults, evaluate <tt>AppendTo[$Path,"FullPathToKnotTheory"]</tt> within Mathematica before attempting to load <tt>KnotTheory`</tt>.
# If you plan to use <tt>KnotTheory`</tt> often, you may want to move the directory <tt>KnotTheory/</tt> into one of the directories on your path. Evaluate <tt>$Path</tt> within Mathematica to see what those are.
# Alternatively, you may permanently add <tt>FullPathToKnotTheory</tt> to your <tt>$Path</tt>. To do that, find your Mathematica base directory by evaluating <tt>$UserBaseDirectory</tt> (on Dror's laptop, this comes out to be <tt>C:\Users\Dror\AppData\Roaming\Mathematica</tt>), and then add the line <tt>AppendTo[$Path,"FullPathToKnotTheory/"]</tt> to the file <tt>$BaseDirectory/Kernel/init.m</tt> and restart Mathematica.

Revision as of 18:07, 21 February 2013


Start by downloading either the file KnotTheory.tar.gz or the file KnotTheory.zip (around 3MB each), and unpack either one. This will create a subdirectory KnotTheory/ in your current working directory. This done, no installation is required (though you may wish to check out Further Data Files and/or Setting the Path below). Start Mathematica and you're ready to go:

In[2]:= << KnotTheory`

Loading KnotTheory` version of March 22, 2011, 21:10:4.67737. Read more at http://katlas.org/wiki/KnotTheory.

Notice the little "prime" at the end of KnotTheory above. It is a backquote (find it on the upper left side of most keyboards) and not a quote, and it really has to be there for things to work.

Let us check that everything is working well:

In[3]:= Alexander[Knot[6, 2]][t]
Out[3]= -2 3 2 -3 - t + - + 3 t - t t
In[4]:= ?KnotTheoryVersion
KnotTheoryVersion[] returns the date of the current version of the package KnotTheory`. KnotTheoryVersion[k] returns the kth field in KnotTheoryVersion[].
In[5]:= ?KnotTheoryVersionString
KnotTheoryVersionString[] returns a string containing the date and time of the current version of the package KnotTheory`. It is generated from KnotTheoryVersion[].
In[6]:= ?KnotTheoryWelcomeMessage
KnotTheoryWelcomeMessage[] returns a string containing the welcome message printed when KnotTheory` is first loaded.

Thus on the day this manual page was last changed, we had:

In[7]:= {KnotTheoryVersion[], KnotTheoryVersionString[]}
Out[7]= {{2011, 3, 22, 21, 10, 4.67737}, March 22, 2011, 21:10:4.67737}
In[8]:= KnotTheoryWelcomeMessage[]
Out[8]= Loading KnotTheory` version of March 22, 2011, 21:10:4.67737. Read more at http://katlas.org/wiki/KnotTheory.
In[9]:= ?KnotTheoryDirectory
KnotTheoryDirectory[] returns the best guess KnotTheory` has for its location on the host computer. It can be reset by the user.
In[10]:= KnotTheoryDirectory[]
Out[10]= C:\Documents and Settings\pc\Documenti\Wolfram\KnotTheory

KnotTheoryDirectory may not work under some operating systems/environments. Please let Dror know if you encounter any difficulties.

Notes

Precomputed Data

KnotTheory` comes with a certain amount of precomputed data which is loaded "on demand" just when it is needed. When a precomputed data file is read by KnotTheory`, a notification message is displayed. To prevent these messages from appearing execute the command Off[KnotTheory::loading].

Further Data Files

To access the Hoste-Thistlethwaite enumeration of knots with 12 to 16 crossings (see Naming and Enumeration), also download either the file DTCodes4Knots12To16.tar.gz or the file DTCodes4Knots12To16.zip (about 9MB each), and unpack either one into the directory KnotTheory/.

Setting the Path

The directions above are written on the assumption that the package KnotTheory` (more precisely, the directory KnotTheory/ containing the files that make this package), is somewhere on your Mathematica search path. Usually this will be the case if KnotTheory/ is a subdirectory of your current working directory. If for some reason Mathematica cannot find KnotTheory`, you may tell it where to look in either of the following three ways. Assume KnotTheory/ is a subdirectory of FullPathToKnotTheory:

  1. If you are using KnotTheory` rarely and you don't want to change system defaults, evaluate AppendTo[$Path,"FullPathToKnotTheory"] within Mathematica before attempting to load KnotTheory`.
  2. If you plan to use KnotTheory` often, you may want to move the directory KnotTheory/ into one of the directories on your path. Evaluate $Path within Mathematica to see what those are.
  3. Alternatively, you may permanently add FullPathToKnotTheory to your $Path. To do that, find your Mathematica base directory by evaluating $UserBaseDirectory (on Dror's laptop, this comes out to be C:\Users\Dror\AppData\Roaming\Mathematica), and then add the line AppendTo[$Path,"FullPathToKnotTheory/"] to the file $BaseDirectory/Kernel/init.m and restart Mathematica.