Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jnywong authored Dec 5, 2024
1 parent cf4542a commit dbcca2b
Showing 1 changed file with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,35 @@
# demo-Sciencecore-climaterisk
# demo-Sciencecore-climaterisk

> [!note]
> See the original [MyST site](https://sciencecore.github.io/climaterisk/) and [GitHub repository](https://github.com/ScienceCore/climaterisk) for more information.
![banner](book/assets/banner.jpg)

Using NASA Earthdata Cloud data to assess the risk of wildfire, drought, and flood.

## Usage

### 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, then in a terminal you should:

1. Clone this repository
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 [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/ScienceCore/climaterisk/graphs/contributors).

## Credits

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 dbcca2b

Please sign in to comment.