https://github.com/vanvalenlab/bebi205
Repo for Caltech's Be/Bi 205 course
https://github.com/vanvalenlab/bebi205
Last synced: about 1 year ago
JSON representation
Repo for Caltech's Be/Bi 205 course
- Host: GitHub
- URL: https://github.com/vanvalenlab/bebi205
- Owner: vanvalenlab
- License: other
- Created: 2021-01-10T19:44:50.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-31T20:25:05.000Z (about 3 years ago)
- Last Synced: 2025-01-04T18:31:28.497Z (over 1 year ago)
- Language: Jupyter Notebook
- Homepage: https://vanvalenlab.github.io/bebi205/
- Size: 26.2 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bebi205
Course notes and materials for bebi205
## Usage
### Building the book
If you'd like to develop on and build the bebi205 book, you should:
- Clone this repository and run
- Run `pip install requirements-book.txt` (it is recommended you do this within a virtual environment)
- (Recommended) Remove the existing `bebi205/_build/` directory
- Run `jupyter-book build bebi205/`
A fully-rendered HTML version of the book will be built in `bebi205/_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 main.
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 bebi205/_build/html`
This will automatically push your build to the `gh-pages` branch. More information on this hosting process can be found [here](https://jupyterbook.org/publish/gh-pages.html#manually-host-your-book-with-github-pages).
## Contributors
We welcome and recognize all contributions. You can see a list of current contributors in the [contributors tab](https://github.com/vanvalen/bebi205/graphs/contributors).
## Credits
This project is created using the excellent open source [Jupyter Book project](https://jupyterbook.org/) and the [executablebooks/cookiecutter-jupyter-book template](https://github.com/executablebooks/cookiecutter-jupyter-book).