search

AMA-Labs / cal-notebooks

CEOS Analytics Laboratory notebooks and tools
0 stars 1 forks source link

readme

cal-notebooks

CEOS Analytics Laboratory notebooks and tools

To add these notebooks to your user enviroment just click on the link below: Click here to add notebooks!

This link will pull the latest version of the notebooks into your enviroment while merging your changes. If you click the link again all un changed notebooks will be updated to the most recent version. If you would like the original version of the notebook simply change the nameo of your copy and click the link again.

Contributing

Contributions are welcome.

A pre-commit hook is provided in /bin. For each notebook committed:

  1. Create an HTML copy of the notebook into html/.
  2. Strip outputs from the notebook to limit the size of the repository.

The apply_hooks.sh script creates a symlink to bin/pre-commit.

# Run this in your local repository
sh bin/apply_hooks.sh

For contributors:

  1. Apply the pre-commit hook.
  2. Run each notebook (that has been updated) to populate the figures, tables and other outputs as you want them.
  3. For each new notebook add a link to html/readme.md.
  4. git add and git commit.
  5. If eveything looks ok, git push to your fork of this repository and create a pull request.

HTML examples