Skip to content

Commit bec0b37

Browse files
author
Kasper Peeters
committed
Update docs
1 parent ba49837 commit bec0b37

File tree

5 files changed

+63
-65
lines changed

5 files changed

+63
-65
lines changed

‎.github/workflows/ubuntu-22.04-package.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ jobs:
5353
5454
- name: Upload Release Assets
5555
run: |
56-
gh release upload "${{ env.VERSION }}" build/cadabra2-${{ env.VERSION }}-22.04-jammy.deb --clobber
56+
gh release upload "${{ env.VERSION }}" build/cadabra2-${{ env.VERSION }}-ubuntu-22.04-jammy.deb --clobber
5757
env:
5858
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5959

‎.github/workflows/ubuntu-24.04-package.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Create an Ubuntu 22.04 package on a github release event.
1+
# Create an Ubuntu 24.04 package on a github release event.
22
# This assumes that the cadabra version is the same as the
33
# release name, and it will attempt to add the .deb file
44
# to the release assets.
@@ -53,7 +53,7 @@ jobs:
5353
5454
- name: Upload Release Assets
5555
run: |
56-
gh release upload "${{ env.VERSION }}" build/cadabra2-${{ env.VERSION }}-24.04-noble.deb --clobber
56+
gh release upload "${{ env.VERSION }}" build/cadabra2-${{ env.VERSION }}-ubuntu-24.04-noble.deb --clobber
5757
env:
5858
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5959

‎README.rst‎

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -383,21 +383,16 @@ Windows
383383
On Windows the main constraint on the build process is that we want to
384384
link to Anaconda's Python, which has been built with Visual
385385
Studio. The recommended way to build Cadabra is thus to build against
386-
libraries which are all built using Visual Studio as well (if you are
387-
happy to not use Anaconda, you can also build with the excellent MSYS2
388-
system from https://www.msys2.org/). It is practically impossible to
389-
build all dependencies yourself without going crazy, but fortunately
390-
that is not necessary because of the VCPKG library at
391-
https://github.com/Microsoft/vcpkg. This contains all dependencies
392-
(boost, gtkmm, sqlite and various others) in ready-to-use form.
386+
libraries which are all built using Visual Studio as well. It is
387+
practically impossible to build all dependencies yourself without
388+
going crazy, but fortunately that is not necessary because of the
389+
VCPKG library at https://github.com/Microsoft/vcpkg. This contains all
390+
dependencies (boost, gtkmm, sqlite and various others) in ready-to-use
391+
form.
393392

394393
If you do not already have it, first install Visual Studio Community
395394
Edition from https://www.visualstudio.com/downloads/ and install
396395
Anaconda (a 64 bit version!) from https://www.anaconda.com/download/.
397-
You also need a TeX distribution, for instance MiKTeX from
398-
https://miktex.org and of course git from
399-
e.g. https://gitforwindows.org/. You need all four before you can
400-
start building Cadabra.
401396

402397
The instructions below are for building using the Visual Studio 'x64
403398
Native Tools Command Prompt' (not the GUI). First, clone the vcpkg

‎cmake/packaging.cmake‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,12 +153,12 @@ else()
153153
message("-- This is an Ubuntu 20.04 system")
154154
endif()
155155
if(LINUX_ISSUE MATCHES "22.04")
156-
set(CPACK_SYSTEM_NAME "22.04-jammy")
156+
set(CPACK_SYSTEM_NAME "ubuntu-22.04-jammy")
157157
set(CPACK_DEBIAN_PACKAGE_DEPENDS "python3, libgmpxx4ldbl, libboost-system1.74.0, libboost-filesystem1.74.0, libboost-program-options1.74.0, libboost-regex1.74.0, libstdc++6, uuid-runtime, libgtkmm-3.0-1v5, python3-matplotlib, python3-mpmath, python3-sympy, python3-gmpy2")
158158
message("-- This is an Ubuntu 22.04 system")
159159
endif()
160160
if(LINUX_ISSUE MATCHES "24.04")
161-
set(CPACK_SYSTEM_NAME "24.04-noble")
161+
set(CPACK_SYSTEM_NAME "ubuntu-24.04-noble")
162162
set(CPACK_DEBIAN_PACKAGE_DEPENDS "python3, libgmpxx4ldbl, libboost-system1.83.0, libboost-filesystem1.83.0, libboost-program-options1.83.0, libboost-regex1.83.0, libstdc++6, uuid-runtime, libgtkmm-3.0-1t64, python3-matplotlib, python3-mpmath, python3-sympy, python3-gmpy2")
163163
message("-- This is an Ubuntu 24.04 system")
164164
endif()

‎web2/cadabra2/source/download.html‎

Lines changed: 52 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -17,57 +17,58 @@ <h2>Build from source (Linux/macOS/Windows)</h2>
1717
<p>
1818
You can build .deb and .rpm packages yourself when building from
1919
source, by running <code>sudo cpack</code> after a successful
20-
build. Note that on rpm systems this requires the use
21-
of <code>cmake3</code> and <code>cpack3</code>; the default cmake will lead to a broken package.
20+
build.
2221
</p>
2322

2423
<h2>Binary packages</h2>
2524
<p>
26-
Packages for various Linux distributions and for Windows (beta!) are
27-
available for download here. Installation on macOS can be done
28-
through HomeBrew or Conda; see below.
25+
Packages for various Linux distributions are available
26+
for <a href="https://github.com/kpeeters/cadabra2/releases/latest">download
27+
from github</a>. These are generated automatically on every
28+
release. Installation on macOS can be done through HomeBrew or
29+
MacPorts; see below. There is also a Docker image if you only want
30+
to use Cadabra via Jupyter.
2931
</p>
3032
<p>
31-
Use at your own risk. Because of time constraints some of these
32-
packages receive almost no testing, so any feedback is welcome.
33-
If you want to help getting these into official distribution
34-
repositories, please let me know.
33+
Use these packages at your own risk. Because of time constraints
34+
some of these packages receive almost no testing, so any feedback is
35+
welcome. If you want to help getting these into official
36+
distribution repositories, please let me know.
3537
</p>
3638

3739
<div class="packages">
3840
<div class="distrotype">
3941
<img src="static/images/appimage.svg"/>
40-
<div class="distronum"><a href="https://cadabra.science/packages/appimage-x86_64">Cadabra AppImage (for x86_64)</a></div>
41-
<div class="distronum"><a href="https://cadabra.science/packages/appimage-aarch64">Cadabra AppImage (for aarch64)</a></div>
4242
<div class="distrotxt">
4343
The AppImage version of Cadabra can be installed on any
4444
reasonably modern Linux distribution and it is completely
4545
self-contained. Just download and make the file executable
46-
with <tt>chmod u+x *.AppImage</tt>.
46+
with <tt>chmod u+x *.AppImage</tt>. Versions are provided for
47+
<tt>x86_64</tt> and <tt>aarch64</tt> architectures from
48+
the <a href="https://github.com/kpeeters/cadabra2/releases/latest">github
49+
release page</a>.
4750
</div>
4851
</div>
4952

5053
<div class="distrotype">
5154
<img src="static/images/ubuntulogo.png"/>
52-
<div class="distronum"><a href="https://cadabra.science/packages/ubuntu1804">Ubuntu Bionic Beaver 18.04</a></div>
53-
<div class="distronum"><a href="https://cadabra.science/packages/ubuntu2004">Ubuntu Focal Fossa 20.04</a></div>
54-
<div class="distronum"><a href="https://cadabra.science/packages/ubuntu2204">Ubuntu Jammy Jellyfish 22.04</a></div>
5555
<div class="distrotxt">
56-
Cadabra is now also available in Ubuntu 22.04 from the official
57-
repositories, by installing the <tt>cadabra2</tt> package
58-
(though this may not always be the most recent version). Thanks
59-
to Alex Myczko for making this happen.
56+
Packages for Ubuntu 22.04 Jammy and 24.04 Noble are available
57+
from
58+
the <a href="https://github.com/kpeeters/cadabra2/releases/latest">github
59+
release page</a>. Cadabra is now also available from the
60+
official repositories, by installing the <tt>cadabra2</tt>
61+
package (though this may not always be the most recent
62+
version). Thanks to Alex Myczko for making this happen.
6063
</div>
6164
</div>
6265

6366
<div class="distrotype">
6467
<img src="static/images/fedora-logo.png"/>
65-
<div class="distronum"><a href="https://cadabra.science/packages/fedora28/">Fedora 28</a></div>
66-
<div class="distronum"><a href="https://cadabra.science/packages/fedora29/">Fedora 29</a></div>
67-
<div class="distronum"><a href="https://cadabra.science/packages/fedora32/">Fedora 32</a></div>
68-
<div class="distronum"><a href="https://cadabra.science/packages/fedora33/">Fedora 33</a></div>
69-
<div class="distronum"><a href="https://cadabra.science/packages/fedora35/">Fedora 35</a></div>
7068
<div class="distrotxt">
69+
Packages for Fedora 40 are available from
70+
the <a href="https://github.com/kpeeters/cadabra2/releases/latest">github
71+
release page</a>.
7172
</div>
7273
</div>
7374

@@ -102,14 +103,16 @@ <h2>Binary packages</h2>
102103

103104
<div class="distrotype">
104105
<img src="static/images/opensuse_logo.png"/>
105-
<div class="distronum"><a href="https://cadabra.science/packages/opensuse150/">openSUSE Leap 15.0</a></div>
106-
<div class="distronum"><a href="https://cadabra.science/packages/opensusetw/">openSUSE Tumbleweed</a></div>
106+
<div class="distrotxt">
107+
A package for openSUSE Tumbleweed is available from
108+
the <a href="https://github.com/kpeeters/cadabra2/releases/latest">github
109+
release page</a>. You can still build it on openSUSE Leap, but you will need
110+
to build from source or rely on 3rd party repositories.
111+
</div>
107112
</div>
108113

109114
<div class="distrotype">
110115
<img src="static/images/debian-logo.jpg"/>
111-
<div class="distronum"><a href="https://cadabra.science/packages/debian9/">Debian Stretch 9</a></div>
112-
<div class="distronum"><a href="https://cadabra.science/packages/debian10/">Debian Buster 10</a></div>
113116
<div class="distrotxt">
114117
Cadabra is now available in Debian 11 (Bullseye) from the
115118
official repositories, by installing the <tt>cadabra2</tt>
@@ -135,27 +138,27 @@ <h2>Binary packages</h2>
135138
<div class="distrotype">
136139
<img src="static/images/apple_logo.png"/>
137140
<div class="distronum">macOS</a></div>
138-
<div class="distrotxt">
139-
Cadabra is available via the Homebrew package manager. Simply
140-
do
141-
<code>brew tap kpeeters/repo</code>
142-
<code>brew install cadabra2</code>
143-
If you encounter problems, please
144-
email <a href="mailto:[email protected]">[email protected]</a>
145-
so they can be fixed and other people can benefit from it.
146-
</div>
147-
<div class="distrotxt">
148-
Cadabra is
149-
also <a href="https://ports.macports.org/port/cadabra2/">available
150-
via MacPorts</a>,
151-
<code>sudo port install cadabra2</code>
152-
should do the trick. For more details follow the link above.
153-
</div>
154-
<div class="distrotxt">
155-
If you want to build from source,
156-
see <a href="https://github.com/kpeeters/cadabra2#macos">macOS
157-
build instructions</a> for details.
158-
</div>
141+
<div class="distrotxt">
142+
Cadabra is available via the Homebrew package manager. Simply
143+
do
144+
<code>brew tap kpeeters/repo</code>
145+
<code>brew install cadabra2</code>
146+
If you encounter problems, please
147+
email <a href="mailto:[email protected]">[email protected]</a>
148+
so they can be fixed and other people can benefit from it.
149+
</div>
150+
<div class="distrotxt">
151+
Cadabra is
152+
also <a href="https://ports.macports.org/port/cadabra2/">available
153+
via MacPorts</a>,
154+
<code>sudo port install cadabra2</code>
155+
should do the trick. For more details follow the link above.
156+
</div>
157+
<div class="distrotxt">
158+
If you want to build from source,
159+
see <a href="https://github.com/kpeeters/cadabra2#macos">macOS
160+
build instructions</a> for details.
161+
</div>
159162
</div>
160163

161164
<a name="windows"></a>

0 commit comments

Comments
 (0)