Skip to content

Commit de98854

Browse files
committed
Update README on the Jupyter kernel
1 parent 189a587 commit de98854

File tree

3 files changed

+25
-8
lines changed

3 files changed

+25
-8
lines changed

README.rst

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ See `Building Cadabra as C++ library`_ for instructions on how to
6262
build the entire Cadabra functionality as a library which you can use
6363
in a C++ program.
6464

65-
See `Building a Jupyter kernel`_ for instructions on how to build a
66-
Jupyter kernel for Cadabra sessions.
65+
See `Building a Jupyter kernel`_ for information on the Jupyter kernel
66+
for Cadabra sessions.
6767

6868

6969
Linux (Debian/Ubuntu/Mint)
@@ -452,11 +452,20 @@ binary installer does).
452452
Building a Jupyter kernel
453453
-------------------------
454454

455-
The Cadabra build scripts are now able to build a Jupyter kernel for
456-
Cadabra, so that you can use the Cadabra notation inside a Jupyter
457-
notebook session. For full instructions, see
458-
`building a Jupyter kernel <https://github.com/kpeeters/cadabra2/blob/master/JUPYTER.rst>`_. This is
459-
*experimental* at the moment; all feedback is welcome.
455+
As of version 2.3.4 the standard build process (as described above)
456+
also creates a Jupyter kernel, which is written in Python on top of
457+
`ipykernel` (thanks to Fergus Baker). This should work on most
458+
platforms out-of-the-box; you do not need to do anything else. The
459+
Jupyter kernel allows you to use Cadabra notation inside a Jupyter
460+
notebook session.
461+
462+
The distribution also still contains code for the 'old' Jupyter
463+
kernel, which is written in C++ on top of `xeus`. Building this kernel
464+
is more complicated mainly because of this dependency, and there is
465+
not much of an advantage over the Python kernel; it's mainly left in
466+
the tree for future reference, For full instructions on how to build
467+
the old `xeus`-based kernel, see
468+
https://github.com/kpeeters/cadabra2/blob/master/JUPYTER.rst.
460469

461470

462471
Tutorials and other help

cmake/version.cmake

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
set(CADABRA_VERSION_MAJOR 2)
22
set(CADABRA_VERSION_MINOR 3)
33
set(CADABRA_VERSION_PATCH 5)
4-
set(CADABRA_VERSION_TWEAK 0)
4+
set(CADABRA_VERSION_TWEAK 1)
55
set(COPYRIGHT_YEARS "2001-2020")
66
math(EXPR SYSTEM_BITS "${CMAKE_SIZEOF_VOID_P} * 8")
77
find_program(GIT git PATHS ${GIT_DIR})

web2/cadabra2/source/changelog.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@ <h1>Change log</h1>
1717
</p>
1818
<a name="master"></a>
1919
<h3>github master (2.3.5)</h3>
20+
<ul>
21+
<li>Once further change to the installation path of
22+
the <tt>cadabra2.so</tt> module, so that it conforms with standard
23+
conventions, in particular Debian packaging rules. On Debian-based
24+
systems, you should now be able to use the Cadabra python module
25+
without path settings, and the Jupyter kernel will work nicely with
26+
the Jupyter package in Debian. </li>
27+
</ul>
2028

2129
<a name="2.3.4"></a>
2230
<h3>2.3.4 (released 16-Nov-2020)</h3>

0 commit comments

Comments
 (0)