https://github.com/bempp/bempp-book

The Jupyter Book on Bempp

https://github.com/bempp/bempp-book

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.0%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

The Jupyter Book on Bempp

Basic Info
  • Host: GitHub
  • Owner: bempp
  • License: other
  • Language: TeX
  • Default Branch: master
  • Size: 6.66 MB
Statistics
  • Stars: 5
  • Watchers: 4
  • Forks: 6
  • Open Issues: 5
  • Releases: 0
Created almost 6 years ago · Last pushed over 1 year ago
Metadata Files
Readme Contributing License

README.md

The Bempp Book

This cookiecutter creates a simple boilerplate for a Jupyter Book.

Usage

Building the book

If you'd like to develop on and build the The Bempp Book book, you should:

  • Clone this repository and run
  • Run pip install -r requirements.txt (it is recommended you do this within a virtual environment)
  • (Recommended) Remove the existing bempp-book/_build/ directory
  • Run jupyter-book build bempp-book/

A fully-rendered HTML version of the book will be built in bempp-book/_build/html/.

Hosting the book

The html version of the book is hosted on the gh-pages branch of this repo. A GitHub actions workflow has been created that automatically builds and pushes the book to this branch on a push or pull request to master.

If you wish to disable this automation, you may remove the GitHub actions workflow and build the book manually by:

  • Navigating to your local build; and running,
  • ghp-import -n -p -f bempp-book/_build/html

This will automatically push your build to the gh-pages branch. More information on this hosting process can be found here.

Contributors

We welcome and recognize all contributions. You can see a list of current contributors in the contributors tab.

Credits

This project is created using the excellent open source Jupyter Book project and the executablebooks/cookiecutter-jupyter-book template.

Owner

  • Name: Bempp
  • Login: bempp
  • Kind: organization

GitHub Events

Total
  • Issues event: 1
  • Push event: 2
  • Pull request event: 2
  • Fork event: 1
Last Year
  • Issues event: 1
  • Push event: 2
  • Pull request event: 2
  • Fork event: 1