Skip to content

Commit

Permalink
mucho mas
Browse files Browse the repository at this point in the history
  • Loading branch information
robfatland committed Jun 18, 2024
1 parent 38b1002 commit 20b3725
Show file tree
Hide file tree
Showing 60 changed files with 611 additions and 3,477 deletions.
25 changes: 16 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,42 @@
# Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit
helps, and credit will always be given.

Contributions are welcome.


- Report bugs, request features or submit feedback as a [GitHub Issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues).
- Make fixes, add content or improvements using [GitHub Pull Requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)


Ready to contribute? Here's a quick guide


## Contributing website changes

To build our website, we need specific Python packages which are managed with the `conda` and `mamba` tools. If you already do not already have those tools installed, we recommend using the [Mambaforge Installer](https://github.com/conda-forge/miniforge#mambaforge):

To build our website, we need specific Python packages which
are managed with the `conda` and `mamba` tools.
If you already do not already have those tools installed, we recommend using the
[Mambaforge Installer](https://github.com/conda-forge/miniforge#mambaforge):


1. Fork this geosmart's website repo on GitHub.

1. Clone your fork locally:

2. Clone your fork locally:

```sh
git clone https://github.com/geo-smart/use_case_template.git
cd book
```

1. Create a branch to add your changes:
3. Create a branch to add your changes:

```sh
git checkout -b name-of-your-bugfix-or-feature
```

1. Create and activate the "geosmart" conda environment.
4. Create and activate the "geosmart" conda environment.

__NOTE__: If you're running linux or Windows use `conda/conda-linux-64.lock.yml`
```sh
Expand All @@ -39,19 +46,19 @@ To build our website, we need specific Python packages which are managed with th
__NOTE__: If you want to add packages or change the environment,
you must follow the procedure outlined in [./conda/README.md](./conda/README.md).
1. Make your desired changes and build the book locally
5. Make your desired changes and build the book locally
```sh
jb build book
```
__NOTE__: to preview the changes open `book/build/html/index.html`
1. Push your branch to GitHub when you're ready:
6. Push your branch to GitHub when you're ready:

```sh
git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature
```

1. Open a pull request through the GitHub website: https://github.com/geo-smart/use_case_template
7. Open a pull request through the GitHub website: https://github.com/geo-smart/use_case_template
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
[Jupyter Book](https://geo-smart.github.io/oceanography/intro.html), [GitHub repo](https://github.com/geo-smart/oceanography).



# Oceanography Jupyter Book


Expand Down
26 changes: 10 additions & 16 deletions book/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,19 @@ parts:

- caption: Ocean Data Science
chapters:
- file: chapters/ocean_science
- file: chapters/rob/ocean_science
- file: chapters/rob/shallowprofiler
- file: chapters/rob/shallowprofiler_technical
- file: chapters/rob/issues
- file: chapters/rob/anomaly
- file: chapters/rob/data
- file: chapters/rob/anomaly
- file: chapters/rob/argo
- file: chapters/rob/glodap
- file: chapters/rob/modis
- file: chapters/rob/roms
- file: chapters/rob/spectrophotometer
- file: chapters/rob/shallowprofiler_technical
- file: chapters/rob/documentation
- file: chapters/motivation
- file: chapters/methods
- file: chapters/data
- file: chapters/development
- file: chapters/training
- file: chapters/evaluation
- file: chapters/workflow
- file: chapters/reproducibility
- file: chapters/conclusion
- file: chapters/todo
- file: chapters/questions
- file: chapters/troubleshooting
- file: chapters/rob/issues


- caption: Example
chapters:
Expand Down
5 changes: 1 addition & 4 deletions book/chapters/about.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,7 @@
"tags": []
},
"source": [
"The Jupyter Book is [here](https://geo-smart.github.io/oceanography/intro.html).\n",
"\n",
"\n",
"The GitHub repo is [here](https://github.com/geo-smart/oceanography).\n",
"[Jupyter Book](https://geo-smart.github.io/oceanography/intro.html) [GitHub repo](https://github.com/geo-smart/oceanography).\n",
"\n",
"\n",
"# About the GeoSMART Use Case Library\n",
Expand Down
56 changes: 0 additions & 56 deletions book/chapters/conclusion.ipynb

This file was deleted.

42 changes: 0 additions & 42 deletions book/chapters/data.ipynb

This file was deleted.

42 changes: 0 additions & 42 deletions book/chapters/development.ipynb

This file was deleted.

42 changes: 0 additions & 42 deletions book/chapters/evaluation.ipynb

This file was deleted.

Loading

0 comments on commit 20b3725

Please sign in to comment.