Merge pull request #1 from Living-with-machines/dev

add census chapter and newspaper metadata notebook

Author: kmcdono2

.devcontainer/Dockerfile

@@ -0,0 +1,70 @@
+# Start from the Python 3.9
+FROM python:3.10-bullseye
+
+# avoid warnings by switching to noninteractive - may turn off later
+ENV DEBIAN_FRONTEND=noninteractive
+
+# install python
+RUN apt-get update && apt-get install -y \
+    python3.10 \
+    python3-pip \
+    && rm -rf /var/lib/apt/lists/*
+
+# install GDAL
+
+RUN apt-get update && apt-get install -y \
+    libgdal-dev
+
+# install pandoc, pandoc-citeproc, and dependencies for quarto
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    pandoc \
+    pandoc-citeproc \
+    curl \
+    gdebi-core \
+    && rm -rf /var/lib/apt/lists/*
+
+# Download and install Quarto and clean up in the same layer
+RUN curl -LO https://quarto.org/download/latest/quarto-linux-amd64.deb \
+     && dpkg --add-architecture amd64 \
+     && gdebi --non-interactive quarto-linux-amd64.deb \
+     && rm -f quarto-linux-amd64.deb
+
+# set correct deno
+RUN curl -LO https://deno.land/install.sh && \
+    chmod u+x install.sh && \
+    sh install.sh -y && \
+    rm -f install.sh
+
+ENV QUARTO_DENO=/root/.deno/bin/deno
+
+# install dart-sass
+
+RUN curl -LO https://github.com/sass/dart-sass/releases/download/1.83.4/dart-sass-1.83.4-linux-arm64.tar.gz && \
+    tar -xvzf dart-sass-1.83.4-linux-arm64.tar.gz && \
+    mv dart-sass /usr/local/bin/sass && \
+    rm -f dart-sass-1.83.4-linux-arm64.tar.gz
+
+ENV QUARTO_DART_SASS=/usr/local/bin/sass/sass
+
+
+# set correct paths
+
+ENV QUARTO_PANDOC=/opt/quarto/bin/tools/x86_64/pandoc
+ENV QUARTO_ESBUILD=/opt/quarto/bin/tools/x86_64/esbuild
+
+# export QUARTO_DENO_DOM=$DENO_DOM_PLUGIN    ?
+# export QUARTO_SHARE_PATH=$PREFIX/share/quarto    ?
+
+# use pip to install needed packages
+RUN pip install --upgrade pip
+RUN pip install jupyter nbclient nbformat matplotlib pandas plotly
+
+# install lwm specific requirements (i.e. MapReader) -- ==TODO==
+# RUN pip install --no-cache-dir \
+#    mapreader@git+https://github.com/Living-with-machines/MapReader.git@main
+
+WORKDIR /workspace
+
+EXPOSE 8888
+
+CMD ["bash"]

.devcontainer/devcontainer.json

@@ -0,0 +1,33 @@
+{
+    // name - define project name
+    "name": "Python and Quarto Development Container",
+    // build - wrapper for the docker build command. Builds the container whenn dev container is launched.
+    "build": {
+        "dockerfile": "Dockerfile",
+        "context": "."
+    },
+    // Customizations including VSCode settings and extensions
+    "customizations": {
+        "vscode": {
+            "settings": {
+                "python.defaultInterpreterPath": "/usr/local/bin/python"
+            }
+        }
+    },
+    // Extensions to be installed in the dev container
+    "extensions": [
+        "ms-python.python",
+        "quarto.quarto",
+        "ms-toolsai.jupyter",
+        "ms-toolsai.jupyter-renderers",
+        "ms-toolsai.jupyter-keymap",
+        "redhat.vscode-yaml",
+        "ms-azuretools.vscode-docker"
+    ],
+"forwardPorts": [8888],
+// User to be used inside the container
+"remoteUser": "root",
+
+// command to run on terminal after env  launches
+"postCreateCommand": "echo 'Container Ready!'"
+}

.github/workflows/publish.yml

@@ -0,0 +1,36 @@
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+name: Quarto Publish
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+
+      - name: Install Python and Dependencies
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+          cache: 'pip'
+
+      - run: pip install jupyter
+
+      # - run: pip install -r requirements.txt
+
+      # - name: Render and Publish
+      #   uses: quarto-dev/quarto-actions/publish@v2
+      #   with:
+      #     target: gh-pages
+      #   env:
+      #     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -0,0 +1,6 @@
+.vscode/
+.venv/
+cache/
+book/.quarto
+_site
+docs

README.md

@@ -0,0 +1,37 @@
+# Living with Machines GitHub Pages landing page
+
+This repository contains the source code for the Living with Machines GitHub Pages landing page. The landing page is built using [Quarto](https://quarto.org/), an open-source scientific and technical publishing system built on top of [Pandoc](https://pandoc.org/).
+
+The landing page is published at [https://living-with-machines.github.io/](https://living-with-machines.github.io/).
+
+## Development
+
+To build the landing page locally, you will need to install Quarto. You can do this by following the instructions in the [Quarto documentation](https://quarto.org/docs/getting-started/installation.html).
+
+Once you have Quarto installed, you can build the landing page by running the following command in the root of the repository:
+
+```bash
+quarto preview
+```
+
+### Open as a VS Code project
+
+This repository includes a `.devcontainer` directory that allows you to open the repository as a [Visual Studio Code Remote - Containers](https://code.visualstudio.com/docs/remote/containers) project. This will automatically set up a development environment with Quarto installed.
+
+To open the repository as a VS Code project, follow these steps:
+
+1. Install [Docker](https://www.docker.com/get-started) on your machine.
+
+2. Install the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension for Visual Studio Code.
+
+3. Open the repository in Visual Studio Code. (You can do this by running `code .` in the root of the repository or by cloning the repository using the "Clone Repository in Container Volume" command in the Command Palette (Ctrl+Shift+P)).
+
+4. VS Code should display an alert at the bottom right of the window saying "Folder contains a dev container configuration file. Reopen folder to develop in a container". Click "Reopen in Container".  If you don't see this alert, you can open the Command Palette (Ctrl+Shift+P) and run the "Dev Containers: Rebuild and Reopen in Container" command.  
+  
+   ![Reopen in Container](_how-to/dev-container.png)
+
+5. VS Code will now open a new window in a containerized development environment. You can now build the landing page by running the following command in VS Code's built-in terminal:
+
+   ```bash
+    quarto preview book
+    ```

_how-to/dev-container.png

@@ -0,0 +1 @@
+/.quarto/

book/.gitignore

@@ -0,0 +1,42 @@
+color:
+  palette:
+    dark-grey: "#081F2C"
+    light-grey: "#EEEBE5"
+    orange: "#FE4F02"
+    dark-blue: "#091E2C"
+    light-blue: "#D5E0E3"
+  background: light-grey
+  foreground: dark-grey
+  primary: black
+  secondary: light-grey
+  tertiary: orange
+
+logo:
+  large: "_assets/images/logo.svg"
+
+typography:
+  fonts:
+    - family: Nunito
+      source: google
+    - family: Space Mono
+      source: google
+  base: Nunito
+  headings: Nunito
+  link:
+    decoration: underline
+  monospace: Space Mono
+  monospace-inline:
+    color: "#222222"
+    background-color: "#ddeaf1" # or use a named color from `color`
+  monospace-block: 
+    background-color: "#eef4f8"
+
+defaults:
+  bootstrap:
+    rules: |
+      .sidebar-link[role='navigation'] {
+        
+      }
+      .sidebar-item-section {
+ 
+      }