https://github.com/jni/using-python-for-science

The essential guide to using Python for scientists
https://github.com/jni/using-python-for-science

Last synced: about 1 month ago
JSON representation

The essential guide to using Python for scientists

• Host: GitHub
• URL: https://github.com/jni/using-python-for-science
• Owner: jni
• License: other
• Created: 2021-02-26T10:10:22.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-25T07:02:21.000Z (about 3 years ago)
• Last Synced: 2024-10-05T00:31:44.427Z (about 2 months ago)
• Language: TeX
• Size: 16.5 MB
• Stars: 7
• Watchers: 6
• Forks: 2
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Using Python for Science

The essential knowledge source for using Python for scientific projects.

## Usage

### Building the book

If you'd like to develop on and build the using-python-for-science 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 `using-python-for-science/_build/` directory

- Run `jupyter-book build using-python-for-science/`

A fully-rendered HTML version of the book will be built in `using-python-for-science/_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 using-python-for-science/_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/jni/using-python-for-science/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).