-
Notifications
You must be signed in to change notification settings - Fork 22
Brand synchronization #12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
41 commits
Select commit
Hold shift + click to select a range
d7fc618
Added brand file
42aa048
Merge remote-tracking branch 'origin/main' into brand
cwhite911 c170ef0
Updated colors
cwhite911 6066686
Updated fonts and icons
cwhite911 e717498
Matched social icons with docs and website
cwhite911 0e9f10c
Added comment explaining why icons are set with the text tag for the …
cwhite911 8950c18
Updated bootstrap variables with brand
cwhite911 522cc71
Fixed fonts
cwhite911 c2c4f0a
Merge branch 'main' into brand
cwhite911 50a08ca
Started to update styles to match Mkdocs styling
cwhite911 074995b
Merge remote-tracking branch 'upstream/main' into brand
cwhite911 2eae69d
Updated text box styling
cwhite911 f3e4fcf
Added style guide page
cwhite911 aab44bc
Added support button
cwhite911 da33ea1
Added social meta tags
cwhite911 287e3ec
Update styling docs
cwhite911 9a819a5
Updated buttons and callouts
cwhite911 0d06caa
Fixed hover color of footer links
cwhite911 2762551
Added support button to the top of margin
cwhite911 231c3d7
Added support button to the top of margin
cwhite911 0865b55
Added style for when title-block-banner: true
cwhite911 87e5a47
Updated warning and success buttons and callouts
cwhite911 964d881
Updating documentation
cwhite911 54105e7
Apply suggestions from code review
cwhite911 41fc6b7
Update content/tests/listing.qmd
cwhite911 7a55b07
Removed capitalization from h2
cwhite911 d34a169
Enfored sentence case with mixin
cwhite911 fd79c88
Addeed mock data to bib
cwhite911 ced722e
Added additional styles to markdown code blocks with documentation
cwhite911 50a48e5
Renamed listing and change descriptions to explain the what the file …
cwhite911 0857785
Renamed listing and change descriptions to explain the what the file …
cwhite911 35aae64
Improved docs for headings
cwhite911 754137f
Fixed issue with div and spans section
cwhite911 2c41014
Added keyboard short codes
cwhite911 e71cb71
Added code copy colors
cwhite911 cb89624
Added code tabsets
cwhite911 e62ad08
Updated content control for local and prod environments
cwhite911 a9beef9
Removed extra spaces
cwhite911 af1e1b4
Fixed typo
cwhite911 cd8ddf9
Removed code enforcing header to be sentence case because we had too …
cwhite911 a20888c
Updated card title color
cwhite911 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| { | ||
| "hash": "924be59cc65ec1d83de0079693abb610", | ||
| "result": { | ||
| "engine": "jupyter", | ||
| "markdown": "---\ntitle: GRASS Quarto Design Guide\ndescription: Adopted from Quarto Documentatoin\nauthor:\n - name: Corey White\n - name: Sarah White\ndate: May 5, 2025\ndate-modified: today\nformat: \n html:\n other-links:\n - text: GRASS Website\n href: \"{{< var grass.website >}}\"\n code-links:\n - text: Data Import Code\n icon: file-code\n href: data-import.py\n notebook-links: inline\n code-tools: true\n code-copy: true\n code-fold: true\n code-summary: \"Show the code\"\nprofile: local\ntoc: true\ntoc-depth: 3\nlisting: \n - id: lab-reports\n contents: \"*.qmd\"\n type: table\n - id: meeting-notes\n contents: \"*.qmd\"\n type: grid\n - id: default-notes\n contents: \"*.qmd\"\n type: default\ncitation:\n type: article-journal\n container-title: ACM Transactions on Embedded Computing Systems\n volume: 21\n issue: 2\n issued: 2022-03\n issn: 1539-9087\n doi: 10.1145/3514174\nexecute:\n eval: false\n echo: true\n output: false\n\n\n---\n\n# Components Showcase\n\nThis document demonstrates various components available in Quarto.\n\n## Headings\n\n# Heading 1\n## Heading 2\n### Heading 3\n#### Heading 4\n##### Heading 5\n###### Heading 6\n\n## Text Formatting\n\n**Bold Text** \n*Italic Text* \n~~Strikethrough~~ \n`Inline Code`\n\nsuperscript^2^ / subscript~2~\n\n## Lists\n\n### Ordered List\n1. First item\n2. Second item\n3. Third item\n\n### Unordered List\n- Item 1\n- Item 2\n- Item 3\n\n* unordered list\n + sub-item 1\n + sub-item 2\n - sub-sub-item 1\n\n* item 2\n\n Continued (indent 4 spaces)\n\n(@) A list whose numbering\n\ncontinues after\n\n(@) an interruption\n\n### Tasks\n\n- [ ] Task 1\n- [x] Task 2\n\n## Blockquotes\n\n### `>` Blockquote\n\n> This is a blockquote. \n> It can span multiple lines.\n\n### Line Block\n\n| Line Block\n| Spaces and newlines\n| are preserved\n\n## Footnotes\n\nHere is a footnote reference,[^1] and another.[^longnote]\n\n[^1]: Here is the footnote.\n\n[^longnote]: Here's one with multiple blocks.\n\n Subsequent paragraphs are indented to show that they\nbelong to the previous footnote.\n\n { some.code }\n\n The whole paragraph can be indented, or just the first\n line. In this way, multi-paragraph footnotes work like\n multi-paragraph list items.\n\nThis paragraph won't be part of the note, because it\nisn't indented.\n\nHere is an inline note.^[Inlines notes are easier to write,\nsince you don't have to pick an identifier and move down to\ntype the note.]\n\n## Tables\n\n### Default\n\n| Header 1 | Header 2 | Header 3 |\n|----------|----------|----------|\n| Row 1 | Data 1 | Data 2 |\n| Row 2 | Data 3 | Data 4 |\n\n```md\n| Header 1 | Header 2 | Header 3 |\n|----------|----------|----------|\n| Row 1 | Data 1 | Data 2 |\n| Row 2 | Data 3 | Data 4 |\n```\n\n### Column Aligned\n\n| Default | Left | Right | Center |\n|---------|:-----|------:|:------:|\n| 12 | 12 | 12 | 12 |\n| 123 | 123 | 123 | 123 |\n| 1 | 1 | 1 | 1 |\n\n```{md}\n| Default | Left | Right | Center |\n|---------|:-----|------:|:------:|\n| 12 | 12 | 12 | 12 |\n| 123 | 123 | 123 | 123 |\n| 1 | 1 | 1 | 1 |\n```\n\n### Pipe Format\n\nfruit| price\n-----|-----:\napple|2.05\npear|1.37\norange|3.09\n\n: Demonstration of pipe table syntax\n\n### Pipe Format Striped\n\n| fruit | price |\n|--------|--------|\n| apple | 2.05 |\n| pear | 1.37 |\n| orange | 3.09 |\n\n: Fruit prices {.striped .hover}\n\n### Pipe Format Custom Col widths\n\n| fruit | price |\n|--------|--------|\n| apple | 2.05 |\n| pear | 1.37 |\n| orange | 3.09 |\n\n: Fruit prices {tbl-colwidths=\"[75,25]\"}\n\n### Grid Table\n\n+-----------+-----------+--------------------+\n| Fruit | Price | Advantages |\n+===========+===========+====================+\n| Bananas | $1.34 | - built-in wrapper |\n| | | - bright color |\n+-----------+-----------+--------------------+\n| Oranges | $2.10 | - cures scurvy |\n| | | - tasty |\n+-----------+-----------+--------------------+\n\n: Sample grid table.\n\n## Cross Reference\n\n| Col1 | Col2 | Col3 |\n|------|------|------|\n| A | B | C |\n| E | F | G |\n| A | G | G |\n\n: My Caption {#tbl-letters}\n\nSee @tbl-letters.\n\n### Subtables\n\n::: {#tbl-panel layout-ncol=2}\n| Col1 | Col2 | Col3 |\n|------|------|------|\n| A | B | C |\n| E | F | G |\n| A | G | G |\n\n: First Table {#tbl-first}\n\n| Col1 | Col2 | Col3 |\n|------|------|------|\n| A | B | C |\n| E | F | G |\n| A | G | G |\n\n: Second Table {#tbl-second}\n\nMain Caption\n:::\n\nSee @tbl-panel for details, especially @tbl-second.\n\n## Links & Images\n\n[GRASS Website]({{< var grass.website >}})\n\n{{< var grass.website >}}\n\n## Images\n\n{width=25%}\n\n{width=50%}\n\n{width=75%}\n\n{width=100%}\n\n### Image Link\n\n[{width=20%}]({{< var grass.website >}})\n\n[{width=20%}]({{< var grass.website >}})\n\n### Aligned Images\n\n{width=20% fig-align=\"left\"}\n{width=20% fig-align=\"right\"}\n\n### Lightbox\n{width=20% fig-align=\"center\" .lightbox}\n\n### Placeholders\n\n{{< placeholder 400 200 format=svg >}}\n\n## Brand\n\nUsing `{{< brand logo small light >}}` from the `_brand.yml` file.\n\n### Logo small light\n{{< brand logo small light >}}\n\n<!-- #### Logo medium dark\n{{< brand logo medium light >}} -->\n\n## Callouts\n\nNote that there are five types of callouts, including: \n`note`, `tip`, `warning`, `caution`, and `important`.\n\n\n### Note\n\n::: {.callout-note}\nThis is a note callout.\n:::\n\n### Warning\n\n::: {.callout-warning}\nThis is a warning callout.\n:::\n\n### Tip\n\n::: {.callout-tip}\nThis is a warning callout.\n:::\n\n### Important\n\n::: {.callout-important}\nThis is a warning callout.\n:::\n\n### Caution\n\n::: {.callout-caution collapse=\"true\"}\n## Expand To Learn About Collapse\nThis is a caution callout.\n:::\n\n## Math\n\n### Inline\nInline math: $E = mc^2$\n\n### Block\n\nBlock math: \n$$\n\\int_a^b f(x) dx = F(b) - F(a)\n$$\n\n### TeX Macro\n::: {.hidden}\n$$\n \\def\\RR{{\\bf R}}\n \\def\\bold#1{{\\bf #1}}\n$$\n:::\n\n## Buttons\n\n[Primary](#){.btn .btn-primary .btn role=\"button\"}\n[Secondary](#){.btn .btn-secondary .btn role=\"button\"}\n[Donate](#){.btn .btn-primary .gs-support-button .btn role=\"button\"}\n\n[Primary Outline](#){.btn .btn-outline-primary .btn role=\"button\"}\n[Secondary Outline](#){.btn .btn-outline-primary .btn role=\"button\"}\n\n## Alerts\n\n::: {.alert .alert-success}\nThis is a success alert.\n:::\n\n::: {.alert .alert-danger}\nThis is a danger alert.\n:::\n\n## Code Blocks with Syntax Highlighting\n\n### Default\n\n```default\ncode\n```\n\n### Python\n```python\n# Comment\nimport sys\nimport subprocess\n\nsys.path.append(\n subprocess.check_output([\"grass\", \"--config\", \"python_path\"], text=True).strip()\n)\n\nimport grass.script as gs\nimport grass.jupyter as gj\n```\n\n### Terminal\n```bash\ngrass \"~/grassdata/\" --exec script.py \n```\n\n### R\n```r\nlibrary(rgrass)\n\nsession <- initGRASS(gisBase = \"/usr/lib/grass84\", # where grass binaries live, `grass --config path`\n gisDbase = \"/home/user/grassdata\", # path to grass database or folder where your project lives\n location = \"nc_basic_spm_grass7\", # existing project name\n mapset = \"PERMANENT\" # mapset name\n )\n\n```\n\n### Raw Content\n\n```{=html}\n<iframe src=\"https://grass.osgeo.org/\" width=\"500\" height=\"400\"></iframe>\n```\n\n## Diagrams\n\n### Flowchart\n```{mermaid}\nflowchart LR\n A[Hard edge] --> B(Round edge)\n B --> C{Decision}\n C --> D[Result one]\n C --> E[Result two]\n```\n\n### Sequence Diagram\n```{mermaid}\nsequenceDiagram\n participant Alice\n participant Bob\n Alice->>John: Hello John, how are you?\n loop Healthcheck\n John->>John: Fight against hypochondria\n end\n Note right of John: Rational thoughts <br/>prevail!\n John-->>Alice: Great!\n John->>Bob: How about you?\n Bob-->>John: Jolly good!\n```\n\n### Dot\n\n```{dot}\ngraph G {\n layout=neato\n run -- intr;\n intr -- runbl;\n runbl -- run;\n run -- kernel;\n kernel -- zombie;\n kernel -- sleep;\n kernel -- runmem;\n sleep -- swap;\n swap -- runswap;\n runswap -- new;\n runswap -- runmem;\n new -- runmem;\n sleep -- runmem;\n}\n```\n\n## Videos\n\n{{< video https://www.youtube.com/embed/zboP3Z7VBuU >}}\n\n## Page Break\n\npage 1\n\n{{< pagebreak >}}\n\npage 2\n\n## Divs & Spans\n\n### Boarder\n\n::: {.border}\nThis content can be styled with a border\n:::\n\n### Sidebar\n\n::::: {#special .sidebar}\n\n::: {.warning}\nHere is a warning.\n:::\n\nMore content.\n:::::\n\n### Spans\n\n[This is *some text*]{.class key=\"val\"}\n\n\n<span class=\"custom-span\">This is a custom span.</span>\n\n## Listing\n\n### Table\n\n:::{#lab-reports}\n:::\n\n### Grid\n\n:::{#meeting-notes}\n:::\n\n### Default\n:::{#default-notes}\n:::\n\n## Layout\n\n### Column Full screen inset\n::: {.column-screen-inset}\n\n:::\n\n### Column Full screen shaded inset\n::: {.column-shaded-screen-inset}\n\n:::\n\n### Column Margin\n::: {.column-margin}\n\n:::\n\n## Lipsum\n\n### Single Paragraph\n{{< lipsum 1 >}}\n\n### Multi Paragraph\n{{< lipsum 2 random=true >}}\n\n", | ||
| "supporting": [ | ||
| "styling_files" | ||
| ], | ||
| "filters": [], | ||
| "includes": {} | ||
| } | ||
| } |
12 changes: 12 additions & 0 deletions
12
...content/tutorials/get_started/JupyterOnWindows_OSGeo4W_Tutorial/execute-results/html.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| { | ||
| "hash": "7c6836e62a1583bd1a107417cd6a1726", | ||
| "result": { | ||
| "engine": "jupyter", | ||
| "markdown": "---\ntitle: \"Get started with GRASS in Jupyter Notebooks on Windows\"\nauthor: \"Caitlin Haedrich\"\ndate: 2024-06-15\nimage: images/getting_started_grass_jupyternotebook.png\ndate-modified: today\nformat:\n html:\n toc: true\n code-tools: true\n code-copy: true\n code-fold: false\ncategories: [Python, Windows, beginner]\ndescription: Learn how to run GRASS in Jupyter Notebooks on Windows.\nengine: jupyter\nexecute:\n eval: false\njupyter: python3\n---\n\n\nThe development of the Python package `grass.jupyter`, has streamlined the use \nof GRASS is Jupyter notebooks. In this tutorial we will demonstrate the \nrecommended way of running GRASS in Jupyter Notebooks for Windows users.\n\n## Set Up\n\nOn Windows, we'll use the OSGeo4W package manager to setup and update GRASS,\nJupyterlab and other dependencies. Follow the directions below to setup Jupyter \nand GRASS in Windows.\n\n#### 1. Download the OSGeo4W Network Installer\n\nDownload the OSGeo4W network install from [here](https://trac.osgeo.org/osgeo4w/). \nOpen it and select _\"Advanced Install\"_.\n\n#### 2. Install GRASS, Jupyterlab and `grass.jupyter` dependencies\n\nFollow the prompts until you get to the _\"Select Packages\"_ window (the defaults\nare fine for most situations). Use the Search bar to find and select the \nfollowing packages for install (switching from \"Skip\" to the version number):\n\n* `grass`\n* `python3-jupyterlab`\n* `python3-ipywidgets`\n\n{width=60%}\n\n#### 3. Go make a cup of tea\n\nIt may take a minute to install... Click \"Finish\" and exit when it finishes.\n\n#### 4. Open the OSGeo4W Shell and install folium\n\nLaunch the OSGeo4W Shell and install folium with:\n\n`pip install folium`\n\n#### 5. Launch Jupyter Lab\n\nWe're ready to launch jupyterlab now: \n\n`jupyter lab`\n\n\nThis should launch Jupyter lab in your default web browser. Use the left side\npanel to navigate to the notebook you wish to run and you're ready to go!\n\n#### 6. Launching Jupyter Lab in the Future\n\nTo launch Jupyter Lab in the future:\n\n1. Open the OSGeo4W Shell\n2. Launch jupyter lab with `jupyter lab`\n\n\n## Start GRASS within Jupyter\n\nNow, we're ready to code! Let's import the GRASS Python packages and launch\nGRASS. If you want to run this tutorial, please download and unzip the \nNorth Carolina [sample dataset](https://grass.osgeo.org/sampledata/north_carolina/nc_spm_08_grass7.zip).\n\n::: {#b243f45c .cell execution_count=1}\n``` {.python .cell-code}\n# Import standard python packages\nimport sys\nimport subprocess\n\n# Ask GRASS where its Python packages are and add them to the path\ngrass_call = \"grass83\"\nsys.path.append(\n subprocess.check_output([grass_call, \"--config\", \"python_path\"], text=True, shell=True).strip()\n)\n\n# Import the GRASS python packages we need\nimport grass.script as gs\nimport grass.jupyter as gj\n\n# Launch a GRASS session.\ngj.init(\"path/to/nc_spm_08_grass/user1\");\n```\n:::\n\n\n## Using GRASS\n\nNow that we have GRASS running in our notebook, let's try some basic \ncommands. \n\nIn this section, we will set the color table to the `elevation` raster map from\nthe GRASS sample project we downloaded and then display it. \n\n::: {#b23efd61 .cell execution_count=2}\n``` {.python .cell-code}\n# Set the computational region to the study area\ngs.parse_command(\"g.region\", \n raster=\"elevation\", \n flags='pg')\n\n# Set colors for elevation raster\ngs.run_command(\"r.colors\", \n map=\"elevation\", \n color=\"elevation\")\n```\n:::\n\n\n::: {#0d9685ac .cell execution_count=3}\n``` {.python .cell-code}\n# Create Map instance\nimg = gj.Map()\n# Add a raster\nimg.d_rast(map=\"elevation\")\n# Add legend\nimg.d_legend(raster=\"elevation\", at=(55, 95, 80, 84), flags=\"b\")\n# Display map\nimg.show()\n```\n:::\n\n\nNow, we're up and running! Have a look at other tutorials for inspiration on \nthe avenues you can follow with GRASS tools combined with other Python packages. \n\n## Troubleshooting\n\nSomething not working? Here are some common stumbling blocks...\n\n* `FileNotFoundError`\n\n::: {#57d8a58f .cell execution_count=4}\n``` {.python .cell-code}\nFileNotFoundError: [WinError 2] The system cannot find the file specified\n```\n:::\n\n\nCheck the `shell` parameter in the `subprocess.check_output()`. On Windows, \nthis should be `shell=True`. On Mac and Linux operating systems, this should \nbe `shell=False`.\n\n* `CalledProcessError`\n\n::: {#812330be .cell execution_count=5}\n``` {.python .cell-code}\nCalledProcessError: Command '['grass83', '--config', 'python_path']' returned non-zero exit status 1.\n```\n:::\n\n\nCheck which version of GRASS you have installed. On Windows, the `grass_call`\nshould be `grass` followed by the first two digits of the version you have \ninstalled (for example, GRASS 8.4 would be called with `grass84`). On Mac and \nLinux, it should be just `grass`.\n\n* Errors from `gj.init()`\n\nThis command takes several different configurations of the GRASS project \nand mapset location on your system. All the following are examples that work:\n\n```\ngj.init(\"path/to/grassdata\", \"project_name\", \"mapset_name\")\ngj.init(\"path/to/project_name/mapset_name\")\ngj.init(\"../project_name/mapset_name\")\n```\n\nAlso pay attention to the slash direction. Windows uses `\\` in it's file \npaths but the `\\` character in strings is also for escaping characters (for\nexample, putting `\\n` in a string will print a new line). Therefore, you'll \nneed to either switch to forward slashes (`/`) or put double back-slashes \n(`\\\\`).\n\n", | ||
| "supporting": [ | ||
| "JupyterOnWindows_OSGeo4W_Tutorial_files" | ||
| ], | ||
| "filters": [], | ||
| "includes": {} | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.