-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* develop: fix ci builds CI: don't install custom ZeroMQ version (#109) Don't use bin/gap.sh (#108) updated dependencies and fixed some documentation typos
- Loading branch information
Showing
20 changed files
with
2,486 additions
and
2,345 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,59 +1,86 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
|
||
<Chapter> | ||
<Heading>Introduction</Heading> | ||
|
||
<Section> | ||
<Heading>Francy</Heading> | ||
|
||
&Francy; arose from the necessity of having a lightweight framework for building interactive graphics, generated from GAP, running primarily on the web, specially in &Jupyter; environments. | ||
An initial attempt to re-use XGAP and port it was made, but the lack of a standardized data exchange format between GAP and the graphics renderer, and the simplistic initial requirements | ||
of the project were the basis for the creation of a new GAP package. | ||
Take a look at &Francy; functionality on these <URL Text="Jupyter Notebooks">https://mybinder.org/v2/gh/gap-packages/francy/master</URL>. | ||
</Section> | ||
|
||
<Section> | ||
<Heading>Applications</Heading> | ||
|
||
&Francy; has potentially many applications and can be used to provide a graphical representation of data structures, allowing one to navigate through and explore properties or relations of these structures. | ||
In this way, &Francy; can be used to enrich a learning environment where GAP provides a library of thousands of functions implementing algebraic algorithms as well as large data libraries of algebraic objects. | ||
&FrancyMonoids; and &SubgroupLattice; are some example packages using &Francy;. | ||
</Section> | ||
|
||
<Section> | ||
<Heading>Functionality</Heading> | ||
|
||
&Francy; provides an interface to draw graphics using objects. This interface is based on simple concepts of drawing and graph theory, allowing the creation of directed and undirected graphs, trees, line charts, bar charts and scatter charts. | ||
These graphical objects are drawn inside a canvas that includes a space for menus and to display informative messages. | ||
Within the canvas it is possible to interact with the graphical objects by clicking, selecting, dragging and zooming. | ||
</Section> | ||
|
||
<Section> | ||
<Heading>Installation</Heading> | ||
|
||
This package requires the &GAP; packages &JupyterKernel;, &json; and &uuid;, all of which are distributed with &GAP; by default. | ||
&Francy; requires &Jupyter; to be installed on your system. Please note that you need to run the installation commands from the same python version &Jupyter; is installed on. | ||
Currently, &Francy; is supported only on &Jupyter; Lab, if you want to use it on the old &Jupyter; Notebooks, please install the latest supported version: v1.2.4. | ||
In order to install or update &Francy;, please run the following command to download the latest version available from <URL>https://pypi.org/</URL>: | ||
<Log> | ||
mcmartins@local:~$ pip install -U jupyterlab-francy | ||
</Log> | ||
</Section> | ||
|
||
<Section> | ||
<Heading>How it works</Heading> | ||
|
||
&Francy; requires a rendering package to display graphics. &Francy; provides by default 3 Renderers based on D3.js, Vis.js and Graphviz, for rendering the semantic model representations produced by the GAP package. | ||
The renderers can be switched at any time using the user interface, by selecting 'Settings > Renderers' in the main menu. | ||
This library is distributed both as a browser module and as a &Jupyter; Lab extension. | ||
This library can be used in &Jupyter; Lab, using the &JupyterKernel; and the MIME type 'application/vnd.francy+json' to render the document. | ||
Please check the <URL Text="JavaScript Documentation">https://gap-packages.github.io/francy/doc/js/doc/index.html</URL> for more information. | ||
</Section> | ||
|
||
<Section> | ||
<Heading>Publications</Heading> | ||
|
||
<URL Text="ICMS 2018">https://doi.org/10.1007/978-3-319-96418-8_42</URL> | ||
</Section> | ||
<Heading>Introduction</Heading> | ||
|
||
<Section> | ||
<Heading>Francy</Heading> | ||
|
||
&Francy; arose from the necessity of having a lightweight framework for building interactive graphics, generated | ||
from GAP, running primarily on the web, specially in &Jupyter; environments. | ||
An initial attempt to re-use XGAP and port it was made, but the lack of a standardized data exchange format | ||
between | ||
GAP and the graphics renderer, and the simplistic initial requirements | ||
of the project were the basis for the creation of a new GAP package. | ||
Take a look at &Francy; functionality on these | ||
<URL Text="Jupyter Notebooks">https://mybinder.org/v2/gh/gap-packages/francy/master</URL>. | ||
</Section> | ||
|
||
<Section> | ||
<Heading>Applications</Heading> | ||
|
||
&Francy; has potentially many applications and can be used to provide a graphical representation of data | ||
structures, | ||
allowing one to navigate through and explore properties or relations of these structures. | ||
In this way, &Francy; can be used to enrich a learning environment where GAP provides a library of thousands of | ||
functions implementing algebraic algorithms as well as large data libraries of algebraic objects. | ||
&FrancyMonoids; and &SubgroupLattice; are some example packages using &Francy;. | ||
</Section> | ||
|
||
<Section> | ||
<Heading>Functionality</Heading> | ||
|
||
&Francy; provides an interface to draw graphics using objects. This interface is based on simple concepts of | ||
drawing | ||
and graph theory, allowing the creation of directed and undirected graphs, trees, line charts, bar charts and | ||
scatter charts. | ||
These graphical objects are drawn inside a canvas that includes a space for menus and to display informative | ||
messages. | ||
Within the canvas it is possible to interact with the graphical objects by clicking, selecting, dragging and | ||
zooming. | ||
</Section> | ||
|
||
<Section> | ||
<Heading>Installation</Heading> | ||
|
||
This package requires the &GAP; packages &JupyterKernel;, &json; and &uuid;, all of which are distributed | ||
with &GAP; | ||
by default. | ||
&Francy; requires &Jupyter; to be installed on your system. Please note that you need to run the installation | ||
commands | ||
from the same python version &Jupyter; is installed on. | ||
Currently, &Francy; is supported only on &Jupyter; Lab, if you want to use it on the old &Jupyter; Notebooks, | ||
please | ||
install the latest supported version: v1.2.4. | ||
In order to install or update &Francy;, please run the following command to download the latest version | ||
available | ||
from <URL>https://pypi.org/</URL>: | ||
<Log> | ||
mcmartins@local:~$ pip install -U jupyterlab-francy | ||
</Log> | ||
</Section> | ||
|
||
<Section> | ||
<Heading>How it works</Heading> | ||
|
||
&Francy; requires a rendering package to display graphics. &Francy; provides by default 3 Renderers based on | ||
D3.js, | ||
Vis.js and Graphviz, for rendering the semantic model representations produced by the GAP package. | ||
The renderers can be switched at any time using the user interface, by selecting 'Settings > Renderers' in the | ||
main menu. | ||
This library is distributed both as a browser module and as a &Jupyter; Lab extension. | ||
This library can be used in &Jupyter; Lab, using the &JupyterKernel; and the MIME type | ||
'application/vnd.francy+json' | ||
to render the document. | ||
Please check the | ||
<URL Text="JavaScript Documentation">https://gap-packages.github.io/francy/doc/js/doc/index.html</URL> | ||
for more information. | ||
</Section> | ||
|
||
<Section> | ||
<Heading>Publications</Heading> | ||
|
||
<URL Text="ICMS 2018">https://doi.org/10.1007/978-3-319-96418-8_42</URL> | ||
</Section> | ||
|
||
</Chapter> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.