Skip to content

Commit 7cc8ba6

Browse files
mfisher87mfisher87
committed
Init
0 parents  commit 7cc8ba6

11 files changed

Lines changed: 681 additions & 0 deletions

File tree

‎.gitattributes‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# SCM syntax highlighting & preventing 3-way merges
2+
pixi.lock merge=binary linguist-language=YAML linguist-generated=true

‎.github/workflows/deploy.yml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# This file was created automatically with `myst init --gh-pages` 🪄 💚
2+
# Ensure your GitHub Pages settings for this repository are set to deploy with **GitHub Actions**.
3+
4+
name: MyST GitHub Pages Deploy
5+
on:
6+
push:
7+
# Runs on pushes targeting the default branch
8+
branches: [main]
9+
env:
10+
# `BASE_URL` determines, relative to the root of the domain, the URL that your site is served from.
11+
# E.g., if your site lives at `https://mydomain.org/myproject`, set `BASE_URL=/myproject`.
12+
# If, instead, your site lives at the root of the domain, at `https://mydomain.org`, set `BASE_URL=''`.
13+
BASE_URL: /${{ github.event.repository.name }}
14+
15+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
16+
permissions:
17+
contents: read
18+
pages: write
19+
id-token: write
20+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
21+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
22+
concurrency:
23+
group: 'pages'
24+
cancel-in-progress: false
25+
jobs:
26+
deploy:
27+
environment:
28+
name: github-pages
29+
url: ${{ steps.deployment.outputs.page_url }}
30+
runs-on: ubuntu-latest
31+
steps:
32+
- uses: actions/checkout@v4
33+
- name: Setup Pages
34+
uses: actions/configure-pages@v3
35+
- uses: actions/setup-node@v4
36+
with:
37+
node-version: 18.x
38+
- name: Install MyST
39+
run: npm install -g mystmd
40+
- name: Build HTML Assets
41+
run: myst build --html
42+
- name: Upload artifact
43+
uses: actions/upload-pages-artifact@v3
44+
with:
45+
path: './_build/html'
46+
- name: Deploy to GitHub Pages
47+
id: deployment
48+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# pixi environments
2+
.pixi/*
3+
!.pixi/config.toml
4+
5+
# MyST build outputs
6+
_build

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 The GeoJupyter Community
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# GeoJupyter Use Cases
2+
3+
This is a depository of GeoJupyter community use cases.
4+
5+
This includes existing workflows or processes that need improvement or ideas for new
6+
workflows or processes that could enable new ways of thinking and working with
7+
geospatial data.
8+
9+
Pull requests are more than welcome :D
10+
11+
12+
## Contributing
13+
14+
### Request a use case
15+
16+
Please open a GitHub issue with a _very_ detailed description of your use case.
17+
A good example of the level of detail we're looking for can be found in
18+
[this comment by `@brookisme`](https://github.com/geojupyter/jupytergis/issues/436#issuecomment-2637601373)!
19+
20+
21+
### Add your use case yourself!
22+
23+
#### Fork the repository
24+
25+
Click the fork button towards the top of the GitHub repository home page.
26+
In your fork repository, create a new branch to contain your work.
27+
28+
29+
#### Add a new use case
30+
31+
In your new branch on your fork:
32+
33+
* Add a new use case directory to the root of this repository
34+
* Create an `index.md` file within
35+
* Ensure your document has a descriptive and concise title at the first line, in
36+
sentence case, e.g.:
37+
38+
```markdown
39+
# My use case title
40+
```
41+
42+
* If you have any ancillary files, e.g. diagrams, screenshots, sketches, or animations,
43+
to go with your use case, include those in your new use case directory.
44+
45+
46+
#### Validation checks
47+
48+
We use [`pre-commit`](https://pre-commit.com/) to run validation checks on this repository.
49+
50+
You can either install `pre-commit` locally (e.g. `pixi global install pre-commit` or
51+
`uv tool install pre-commit`), or run pre-commit in your pull request with a comment
52+
containing the text `pre-commit.ci autofix`.
53+
The latter option won't autofix every problem; some must be fixed manually (e.g.
54+
spelling fixes).
55+
56+
57+
#### Open a pull request
58+
59+
Open a pull request targeting the `main` branch of this repository.
60+
Someone will review it as soon as they can!

‎assets/style/style.css‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
body {
2+
font-family: "Source Sans Pro", -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
3+
}

‎explore-multiple-datasets-together/index.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Explore multiple datasets together
2+
3+
Prototype: <https://github.com/geojupyter/jupyter-microgis>
4+
5+
* Add layers to a map for exploration from a Jupyter Notebook:
6+
7+
```python
8+
from ... import explore
9+
10+
explore(
11+
my_xarray_dataarray,
12+
{'data': my_geodataframe, 'symbology': 'choropleth'},
13+
)
14+
```
15+
* Support rioxarray DataArrays
16+
* Support geopandas GeoDataFrames
17+
* Maybe: Support WMTS?
18+
* Support some curated default symbology options
19+
* Choropleth: number of steps, classification mode, ?
20+
* Symbol map: shape, min/max size, ...
21+
* Dot density: ...
22+
* Cartogram: Maybe?
23+
* Support some symbology customization
24+
* Each symbology option provides sensible defauls and allows for detailed
25+
customization if desired.
26+
The point isn't to help people make maps for publication, though.
27+
We're choosing to trade off user control so we can have a simpler API.
28+
* Use a Jupyter Server extension to tile raster data under the covers, e.g.
29+
[rioxarray DataArray -> TiTiler](https://developmentseed.org/titiler/packages/xarray/)
30+
* Send vector data to the renderer as binary (geoarrow)
31+
* Future integration (developed as an independent component): Support a data discovery
32+
interface which can help the user find other data they want to integrate with their
33+
Notebook analysis
34+
* Plain language search
35+
* Produce Python one-liners to bring that dataset into their notebook, e.g. `geopandas.read_file(...)` and `xarray.open_mfdataset(...)`
36+
* Display the data on slippy map widget (e.g. DeckGL)

‎index.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# GeoJupyter use cases
2+
3+
:::{pull-quote}
4+
A depository of geospatial data use cases that need new or improved (e.g.
5+
more open, more reproducible, more joyful, less cognitive load) workflows
6+
:::
7+
8+
To contribute, please visit
9+
[the GitHub repository for this website](https://github.com/geojupyter/use-cases)
10+
and view the README!

‎myst.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
version: 1
2+
3+
project:
4+
title: "GeoJupyter Use Cases"
5+
description: >-
6+
A depository of geospatial data use cases that need new or improved (e.g.
7+
more open, more reproducible, more joyful, less cognitive load) workflows
8+
# keywords: []
9+
# authors: []
10+
license: "MIT"
11+
github: &repo-url "https://github.com/geojupyter/use-cases"
12+
13+
exclude:
14+
- "_*"
15+
- "README.md"
16+
toc:
17+
- file: "index.md"
18+
- pattern: "*/index.md"
19+
20+
21+
site:
22+
template: "book-theme"
23+
actions:
24+
- title: "View source"
25+
url: *repo-url
26+
options:
27+
style: "assets/styles/style.css"
28+
# favicon: favicon.ico
29+
# logo: site_logo.png
30+
logo_text: "GeoJupyter Use Cases"

0 commit comments

Comments
 (0)