Skip to content

Commit

Permalink
docs: expand project workflow docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mtwente committed Oct 15, 2024
1 parent 6da8555 commit d641ef8
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions docs/workflow.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -106,29 +106,27 @@ flowchart TD

### Data Storage

- **Wikidata:** All items that make up the collection of works by Max Vogt were added to Wikidata with a statement specifying Max Vogt as the architect. Display all Wikidata items for buildings by Max Vogt using [this query](https://w.wiki/BSa9). Max Vogt himself also has a wikidata item: [Q1913571](https://www.wikidata.org/wiki/Q1913571). Each built structure has technical information stored in Wikidata, and, where available, information on renovation/restauration timelines. Links to the objects' Wikimedia Commons Categories and OpenStreetMap entries were established using the corresponding Wikidata properties. Where applicable, reference links are provided for statements. Some secondary literature on Max Vogt is also modelled on Wikidata - refer to the items about Max Vogt using [this query](https://w.wiki/BSas).
- **Wikidata:** All items that make up the collection of works by Max Vogt were added to Wikidata with a statement specifying Max Vogt as the architect. Display all Wikidata items for buildings by Max Vogt using [this query](https://w.wiki/BSa9). Max Vogt himself also has a wikidata item: [Q1913571](https://www.wikidata.org/wiki/Q1913571). Each built structure has technical information stored in Wikidata, and, where available, information on renovation/restauration timelines. Links to the objects' Wikimedia Commons Categories and OpenStreetMap entries were established using the corresponding Wikidata properties. Where applicable, reference links are provided for statements. Some secondary literature on Max Vogt is also modelled on Wikidata -- refer to the items about Max Vogt using [this query](https://w.wiki/BSas).

- **Wikimedia Commons:** As part of the field survey in spring/summer 2024, the authors took photos of each collection item and uploaded a selection of them to Wikimedia Commons with the intention of loading those images into CollectionBuilder. A Commons Category for Max Vogt already [existed](https://commons.wikimedia.org/wiki/Category:Max_Vogt) and was restructured to fit with the data model. There are categories for [buildings](https://commons.wikimedia.org/wiki/Category:Buildings_by_Max_Vogt), [fountains](https://commons.wikimedia.org/wiki/Category:Fountains_by_Max_Vogt) and [bridges](https://commons.wikimedia.org/wiki/Category:Bridges_by_Max_Vogt) by Max Vogt with a total of 112 subcategories – one for each structure designed by Vogt where media is available. All uploaded images were annotated comprehensively, with description texts, technical image metadata, and geocoordinates of object and photography locations. An overview map is available [via WikiMap](https://wikimap.toolforge.org/?cat=Max_Vogt&subcats=true&subcatdepth=3). Image metadata is also available as structured data. Wikimedia Commons category pages where linked to the corresponding Wikidata items to add infoboxes on the category pages. In those cases where relevant files had already been uploaded to Wikimedia Commons before, they were also added to the object's category. These third-party files are mostly provided by [SBB Historic](https://www.sbbhistoric.ch/) (see above) or ETH Zurich Library's [E-Pics database](https://e-pics3.ethz.ch/de/home/). As an additional feature, Wikimedia Commons allows users to tag and annotate image regions as in [this file](https://commons.wikimedia.org/wiki/File:Lokomotivdepots_G_und_F_Z%C3%BCrich.jpg). Buildings by Max Vogt were added as notes, linking to the corresponding Wikidata entries. This annotation has only been done for a few singular items so far.
- **Wikimedia Commons:** As part of the field survey in spring/summer 2024, the authors took photos of each collection item and uploaded a selection of them to Wikimedia Commons with the intention of loading those images into CollectionBuilder. A Commons Category for Max Vogt already [existed](https://commons.wikimedia.org/wiki/Category:Max_Vogt) and was restructured to fit the data model. There are categories for [buildings](https://commons.wikimedia.org/wiki/Category:Buildings_by_Max_Vogt), [fountains](https://commons.wikimedia.org/wiki/Category:Fountains_by_Max_Vogt) and [bridges](https://commons.wikimedia.org/wiki/Category:Bridges_by_Max_Vogt) by Max Vogt with a total of 112 subcategories – one for each structure designed by Vogt where media is available. All uploaded images were annotated comprehensively, with description texts, technical image metadata, and geocoordinates of object and photography locations. An overview map is available [via WikiMap](https://wikimap.toolforge.org/?cat=Max_Vogt&subcats=true&subcatdepth=3). Image metadata is also available as [structured data](https://commons.wikimedia.org/wiki/Commons:Structured_data/Modeling). Wikimedia Commons category pages are linked to the corresponding Wikidata items to add infoboxes on the category pages. In those cases where relevant files had already been uploaded to Wikimedia Commons before, they were also added to the object's category. These third-party files are mostly provided by [SBB Historic](https://www.sbbhistoric.ch/) (see above) or ETH Zurich Library's [E-Pics database](https://e-pics3.ethz.ch/de/home/). As an additional feature, Wikimedia Commons allows users to tag and annotate image regions as in [this file](https://commons.wikimedia.org/wiki/File:Lokomotivdepots_G_und_F_Z%C3%BCrich.jpg). Buildings by Max Vogt were added as notes, linking to the corresponding Wikidata entries. This annotation has only been done for a few singular items so far.

- **OpenStreetMap:** All relevant information gathered during the surveys was added to OpenStreetMap (OSM). All OSM data tagged as items by Max Vogt can be displayed via the Overpass API [using this query](https://osm.li/WV_). Except for two of Vogt's works, all were already present in the OSM database. Pre-existing data was enriched with more and up-to-date information from the suveys in spring/summer 2024. Several buildings had to be re-mapped by splitting up larger building complexes that had been mapped as one single item. Via the corresponding OSM tagging scheme, links [to Wikimedia Commons](https://wiki.openstreetmap.org/wiki/Key:wikimedia_commons) and [to Wikidata](https://wiki.openstreetmap.org/wiki/Key:wikidata) were added to the database (and vice versa). Additionally, all buildings were modelled according to the [Simple 3D Buidings tagging scheme](https://wiki.openstreetmap.org/wiki/Simple_3D_Buildings) and are, as of September 2024, available for use in OSM 3D renderers such as the [F4Map Demo](https://demo.f4map.com/#) or Kevin Nowaczyk's [OSM Building renderer](https://github.com/Beakerboy/OSMBuilding). Please note that not all renderers support all features of the Simple 3D Buildings tagging scheme.

- **GitHub Repository *maxvogt*:** The GitHub repository at [*mtwente/maxvogt*](https://github.com/mtwente/maxvogt) is the technical basis for the online collection about Max Vogt set up by the authors. A detailed description is available in the repository's [readme](https://github.com/mtwente/maxvogt/blob/main/README.md). The repository contains an instance of [CollectionBuilder](https://collectionbuilder.github.io/), an open source framework for creating metadata-driven digital collections which is developed at the University Library of Idaho. Barely any actual research data is stored in the repository, since all collection items (images, PDFs, geodata) is fetched from other sources, such as Wikimedia Commons, SBB Archiv and others.
- **GitHub Repository *maxvogt*:** The GitHub repository at [*mtwente/maxvogt*](https://github.com/mtwente/maxvogt) is the technical basis for the online collection about Max Vogt set up by the authors. A detailed description is available in the repository's [readme](https://github.com/mtwente/maxvogt/blob/main/README.md). The repository contains an instance of [CollectionBuilder](https://collectionbuilder.github.io/), an open source framework for creating metadata-driven digital collections which is developed at the University Library of Idaho. Barely any actual research data is stored in the repository, since all collection items (images, PDFs, geodata) are fetched from other sources, such as Wikimedia Commons, SBB Archiv and others.

- **GitHub Repository *maxvogt-analysis*:** The GitHub repository at [*mtwente/maxvogt-analysis](https://github.com/mtwente/maxvogt-analysis) is used for storing research data that was generated as part of this project. The authors provide project documentation, license information, instructions on how to reproduce the data set using Jupyter Notebooks. Geodata that is generated by running the notebooks is stored in the repository in json files, and is fetched from here to be displayed in the [online collection](https://mtwente.github.io/maxvogt) using a Leaflet map. The *maxvogt-analysis* repository is based on the [GitHub template for FAIR and open research data](https://maehr.github.io/open-research-data-template/) by [Moritz Mähr](https://www.moritzmaehr.ch), adhering to best practices for open research data as outlined by [The Turing Way](https://book.the-turing-way.org/index.html).
- **GitHub Repository *maxvogt-analysis*:** The GitHub repository at [*mtwente/maxvogt-analysis*](https://github.com/mtwente/maxvogt-analysis) is used for storing research data that was generated as part of this project. The authors provide project documentation, license information, instructions on how to reproduce the data set using Jupyter Notebooks. Geodata that is generated by running the notebooks is stored in the repository in json files, and is fetched from here to be displayed in the [online collection](https://mtwente.github.io/maxvogt) using a Leaflet map. The *maxvogt-analysis* repository is based on the [GitHub template for FAIR and open research data](https://maehr.github.io/open-research-data-template/) by [Moritz Mähr](https://www.moritzmaehr.ch), adhering to best practices for open research data as outlined by [The Turing Way](https://book.the-turing-way.org/index.html).

- **Zenodo:** The authors use [Zenodo](https://zenodo.org/) for long-term archiving of the project data and its output, e.g. for making the project conference poster [available](https://doi.org/10.5281/zenodo.13837394) in PDF format.

### Output

- **Website *maxvogt*:** One major part of the project is the online collection about Max Vogt's work. This collection is made with CollectionBuilder (see above), which generates a website for browsing the data set and facilitates explorative access to the collection using features such as timelines, maps and wordclouds. The website is hosted using [GitHub Pages](https://pages.github.com/) and is accessible via [https://mtwente.github.io/maxvogt](https://mtwente.github.io/maxvogt).

- **Website *maxvogt-analysis*:**
- **Website *maxvogt-analysis*:** The online collection on Max Vogt is partly built with geodata generated by Jupyter notebooks in the *maxvogt-analysis* repository. The authors built this website to document the project research data. It is built with [Quarto](https://www.quarto.org), see the section about the *maxvogt-analysis* GitHub repository above for more information. The website is hosted using [GitHub Pages](https://pages.github.com/) and is accessible via [https://mtwente.github.io/maxvogt](https://mtwente.github.io/maxvogt-analysis).

. The website is hosted using [GitHub Pages](https://pages.github.com/) and is accessible via [https://mtwente.github.io/maxvogt](https://mtwente.github.io/maxvogt-analysis).
* **Zotero:** The corpus of literature that was consulted for this research project consists of a few academic publications, especially from heritage conservation studies and Swiss architecture guides [e.g. @weidmann_max_2008-1; @noseda_vogt_1998; @allenspach_max_1994; @weidmann_max_2008]. Additionally, there are several articles in newspapers or in architecture journals relating to Vogt's work – either on the occasion of a station's redesign [e.g. @capol_funf_1998; @cieslik_elegant_2020; @hodel_infrastruktur_2019; @huber_schienenstrange_2022; @sbb_immobilien_revival_2023] or as part of obituaries for Vogt [e.g. @vogeli_max_2019; @salm_rohe_2019; @hohler_er_2019; @redaktion_zuriost_max_2019]. Relevant sources for contemporary descriptions of individual buildings are internal SBB documents such as employee newspapers [e.g. @generaldirektion_sbb_fortschritt_1979; @generaldirektion_sbb_grenzbahnhof_1978; @generaldirektion_sbb_neue_1979] and other corporate publications [e.g. @sbb_historic_kulturerbejahr_2018; @sbb_immobilien_revival_2023]. Most of the internal SBB documents are not accessible online. The authors used both [SBB Archives](https://www.sbbarchiv.ch/) or libraries such as the [Basel University Business and Economics Library/Swiss Economoic Archives](https://ub.unibas.ch/en/ubw-swa/). Sources were added to a [shared Zotero library](https://www.zotero.org/groups/5400359/sbb-max-vogt/library) to facilitate access to research on Max Vogt's work.

– **Zotero:** The corpus of literature that was consulted for this research project consists of a few academic publications, especially from heritage conservation studies and Swiss architecture guides [e.g. @weidmann_max_2008-1; @noseda_vogt_1998; @allenspach_max_1994; @weidmann_max_2008]. Additionally, there are several articles in newspapers or in architecture journals relating to Vogt's work – either on the occasion of a station's redesign [e.g. @capol_funf_1998; @cieslik_elegant_2020; @hodel_infrastruktur_2019; @huber_schienenstrange_2022; @sbb_immobilien_revival_2023] or as part of obituaries for Vogt [e.g. @vogeli_max_2019; @salm_rohe_2019; @hohler_er_2019; @redaktion_zuriost_max_2019]. Relevant sources for contemporary descriptions of individual buildings are internal SBB documents such as employee newspapers [e.g. @generaldirektion_sbb_fortschritt_1979; @generaldirektion_sbb_grenzbahnhof_1978; @generaldirektion_sbb_neue_1979] and other corporate publications [e.g. @sbb_historic_kulturerbejahr_2018; @sbb_immobilien_revival_2023]. The latter category of documents is not accessible online. The authors used both [SBB Archives](https://www.sbbarchiv.ch/) or libraries such as the [Basel University Business and Economics Library/Swiss Economoic Archives](https://ub.unibas.ch/en/ubw-swa/). Sources were added to a [shared Zotero library](https://www.zotero.org/groups/5400359/sbb-max-vogt/library) to facilitate access to research on Max Vogt's work.

- **Conference Poster:** See [SpatHum 2024 Poster](../docs/poster.qmd)
- **Conference Poster:** This project was presented at the [Spatial Humanities 2024](https://spathum.uni-bamberg.de/) conference in Bamberg. A poster showcased the project using four selected collection items to exhibit the range of projects that are part of Vogt's catalogue of works. Additionally, information on Vogt's biography and on CollectionBuilder is provided. The poster itself was designed using Adobe InDesign, the drawings were made using Adobe Illustrator, and the map was created with OpenStreetMap geodata in QGIS. The poster is archived on Zenodo, see [SpatHum 2024 Poster](../docs/poster.qmd).


## Tools
Expand Down

0 comments on commit d641ef8

Please sign in to comment.