Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jnywong committed Nov 28, 2024
1 parent 84d6c7b commit 1a85d7e
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,25 @@ Using NASA Earthdata Cloud data to assess the risk of wildfire, drought, and flo

### Building the book

If you'd like to develop and/or build the NASA TOPS-T Reproducibly Analyzing Wildfire, Drought, and Flood Risk with NASA Earthdata Cloud book, you should:
If you'd like to develop and/or build the NASA TOPS-T Reproducibly Analyzing Wildfire, Drought, and Flood Risk with NASA Earthdata Cloud book, then in a terminal 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 `book/` directory
4. Run `jupyter-book clean book/` to remove any existing builds
5. Run `jupyter-book build book/`
1. Run `pip install -r requirements.txt` (it is recommended you do this within a virtual environment)
1. (Optional) Edit the books source files located in the `book/` directory
1. Change to the `book` directory with `cd book/`
1. Run `myst start` to remove any existing builds
1. Run `myst build --html` to build HTML version of book

A fully-rendered HTML version of the book will be built in `book/_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.
Please see the [MyST documentation](https://mystmd.org/guide/deployment) to discover options for deploying a book online using services such as GitHub.

## Contributors

We welcome and recognize all contributions. You can see a list of current contributors in the [contributors tab](https://github.com/jmunroe/nasa-topst/graphs/contributors).
We welcome and recognize all contributions. You can see a list of current contributors in the [contributors tab](https://github.com/ScienceCore/climaterisk/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).
This project is created using the excellent open source [MyST MD](https://mystmd.org) and is funded by NASA Transform to Open Science Training or “TOPST”, Research Opportunities in Space and Earth Science [(ROSES) solicitation F.14](https://nspires.nasaprs.com/external/viewrepositorydocument/cmdocumentid=860824/solicitationId=%7BAB776446-03A8-4C24-845D-2E5A2ADA2D5A%7D/viewSolicitationDocument=1/F.14_TOPST_Amend46.pdf).

0 comments on commit 1a85d7e

Please sign in to comment.