https://github.com/fjebaker/cadabra-resources

Notes, Dockerfiles and tutorials for using Cadabra2.
https://github.com/fjebaker/cadabra-resources

cadabra cadabra-docker cadabra2 cadabra2-docker cadabra2-jupyter docker field-equations general-relativity ipython jupyter physics

Last synced: 29 days ago
JSON representation

Notes, Dockerfiles and tutorials for using Cadabra2.

• Host: GitHub
• URL: https://github.com/fjebaker/cadabra-resources
• Owner: fjebaker
• License: gpl-3.0
• Created: 2020-09-16T15:22:39.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-09-01T13:46:17.000Z (5 months ago)
• Last Synced: 2024-12-21T18:42:37.402Z (about 1 month ago)
• Topics: cadabra, cadabra-docker, cadabra2, cadabra2-docker, cadabra2-jupyter, docker, field-equations, general-relativity, ipython, jupyter, physics
• Language: Jupyter Notebook
• Homepage:
• Size: 46.9 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# cadabra-resources

Notes and tutorials for using Cadabra2.

## Note: ⚠️ there is now an **official Cadabra2 Docker image**

Kasper maintains an official Docker image in the [source tree](https://github.com/kpeeters/cadabra2/tree/master/docker). You can download it directly from Dockerhub [here](https://hub.docker.com/r/kpeeters/cadabra2-jupyter), or using the command line:

```bash

docker image pull kpeeters/cadabra2-jupyter

``` 

I will no longer be maintaining the Dockerfile in this repository.

## Setup

Note, this is by no means a small Dockerfile for Cadabra -- but personally I do not enjoy using `conda` on my work machine, so prefer the modularity of Docker for porting the environment around.

With all of the Cadabra, conda, and Jupyter dependencies, this image comes to a whopping *2.9 GB*. As such, I will not be uploading it to Docker Hub, and instead hosting the Dockerfile here.

**Update:** For the new python jupyter kernel, I created another Dockerfile, this one builds the branch from source and then copies the relevant binaries to a seperate container. The build time is longer, however the resultant final image is *515 MB*, which is a lot more acceptable. 

This container I may make available on Docker Hub in the future for use, since the build time is a little silly.

### Building

```bash

docker build . -t cadabra2-jupyter

```

## Running

```bash

docker run -p 8080:8080 -v $(pwd)/notebooks:/home/cadabra cadabra2-jupyter

```

and follow the tokenized url in your browser to access.

## Notebooks

Most of the notebooks will be derived from a brilliant tutorial by [Leo Brewin](https://github.com/leo-brewin), which you can find [on ArXiv](https://arxiv.org/pdf/1912.08839.pdf).

I include some of my original work without indication, however such amendments serve primarily to aid my own learning.