Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fneum/data-science-for-esm
https://github.com/fneum/data-science-for-esm
data-science energy energy-data energy-system-modelling
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/fneum/data-science-for-esm
- Owner: fneum
- License: mit
- Created: 2022-08-30T13:44:48.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-15T19:18:23.000Z (3 months ago)
- Last Synced: 2025-01-13T14:17:16.684Z (14 days ago)
- Topics: data-science, energy, energy-data, energy-system-modelling
- Language: Jupyter Notebook
- Homepage: https://fneum.github.io/data-science-for-esm/intro.html
- Size: 163 MB
- Stars: 71
- Watchers: 5
- Forks: 37
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Data Science for Energy System Modelling
Course at TU Berlin to learn energy system modelling with data.
## Usage
### Building the book
If you'd like to develop and/or build the Data Science for Energy System Modelling book, you should:
1. Clone this repository
2. Run `pip install -r requirements.txt` (it is recommended you do this within a virtual environment)
3. (Optional) Edit the books source files located in the `data-science-for-esm/` directory
4. Run `jupyter-book clean data-science-for-esm/` to remove any existing builds
5. Run `jupyter-book build data-science-for-esm/`
A fully-rendered HTML version of the book will be built in `data-science-for-esm/_build/html/`.
### Hosting the book
Please see the [Jupyter Book documentation](https://jupyterbook.org/publish/web.html) to discover options for deploying a book online using services such as GitHub, GitLab, or Netlify.
For GitHub and GitLab deployment specifically, the [cookiecutter-jupyter-book](https://github.com/executablebooks/cookiecutter-jupyter-book) includes templates for, and information about, optional continuous integration (CI) workflow files to help easily and automatically deploy books online with GitHub or GitLab. For example, if you chose `github` for the `include_ci` cookiecutter option, your book template was created with a GitHub actions workflow file that, once pushed to GitHub, automatically renders and pushes your book to the `gh-pages` branch of your repo and hosts it on GitHub Pages when a push or pull request is made to the main branch.
## Contributors
We welcome and recognize all contributions. You can see a list of current contributors in the [contributors tab](https://github.com/fneum/data-science-for-esm/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).