Skip to content

Commit

Permalink
Fix linting
Browse files Browse the repository at this point in the history
  • Loading branch information
uekerman committed Oct 16, 2024
1 parent 1bc6f8b commit 0439896
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions 00_organization/topic_overview_demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,28 @@
- We will use [preCICE](https://precice.org/) as an example for many things in this course.
- Briefly sprint through all 6 chapters of the course and preview what we will learn.
- preCICE is a coupling library for partitioned multi-physics simulations, developed at US and TUM.
- 1. Version Control
- Chapter 1. Version Control
- [preCICE organization on GitHub](https://github.com/precice), multi-repo approach
- at the core is a [library called precice](https://github.com/precice/precice)
- forking workflow with protected main branch, develop is default, open a PR, explain source and target
- linear history, show commits
- 2. Virtualization and Containers
- Chapter 2. Virtualization and Containers
- being a coupling library, many software components are involved in actual simulations --> virtualization is an important topic to handle all these components
- [preCICE Docker images](https://hub.docker.com/u/precice) for testing only (preCICE and downstream repositories), not meant for users
- [virtual machine](https://precice.org/installation-vm.html) for demo (sandbox) mode with many components, scripted using Vagrant
- 3. Building and Packaging
- Chapter 3. Building and Packaging
- [installation overview](https://precice.org/installation-overview.html), Debian package, spack, Python bindings on PyPI
- package creation and [building from source](https://precice.org/installation-source-configuration.html) via CMake
- 4. Documentation
- Chapter 4. Documentation
- written in markdown in distributed places (click edit on some page), rendered via jekyll, hosted via GitHub Pages
- distinguish user from dev docs, tutorials, configuration references
- [brief styleguide](https://precice.org/docs-meta-content-guidelines.html)
- [changelog](https://github.com/precice/precice/blob/develop/CHANGELOG.md)
- 5. Testing and Continuous Integration
- Chapter 5. Testing and Continuous Integration
- [unit and integration](https://precice.org/dev-docs-dev-testing.html) tests via Boost.Test
- [tests and more automation](https://github.com/precice/precice/actions) run on Github Actions
- many Python components use unittest
- 6. Miscellaneous
- Chapter 6. Miscellaneous
- LGPL3 license
- semantic versioning scheme
- [distribution published on DaRUS](https://darus.uni-stuttgart.de/dataset.xhtml?persistentId=doi:10.18419/darus-4167)

0 comments on commit 0439896

Please sign in to comment.