Unverified Commit b737ee62 authored by Paul Rougieux's avatar Paul Rougieux
Browse files

Initial README

parent 0ffc9361
Loading
Loading
Loading
Loading
+37 −73
Original line number Diff line number Diff line
# modellierung_fitnessclub
# Introduction

Modellierung Fitnessclub is a monthly meeting where researchers talk about how they
build modelling workflows with coding harnesses (such as Claude code CLI / Cowork). This
is a hands on meeting to share experience that is transferable to other scientific
domains. We are all learning how agentic coding is going to disrupt computer programming
and our modelling work as a result.

-  We can discuss about data representations (such as multidimensional arrays),
   input/output, file storage formats, databases, git version control and issue
   management, integration tests, CI, visualisations plotting, workflow engines to run
   models in a dependency graph and semantics.

## Getting started
- Topics could also be extended to literature research with LLMs that ground their
  answers in existing literature such as Perplexity and Claude and to prompting
  techniques to avoid sycophancy (such as grill-me, expert panel, storm review, hostile
  review).

To make it easy for you to get started with GitLab, here's a list of recommended next steps.
- The 45 minutes meeting could rotate between different forms: 20 minutes frontal
  presentation followed by a discussions, hands on workshop on a modelling tool (such as
  playing with data visualisation based on an existing dataset with parallel agents
  generating plots), completely informal lunch discussion, review of the methods section
  of a modelling paper.

Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!

## Add your files
# Next Meetings:

* [Create](https://docs.gitlab.com/user/project/repository/web_editor/#create-a-file) or [upload](https://docs.gitlab.com/user/project/repository/web_editor/#upload-a-file) files
* [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
Every third Friday of the month

```
cd existing_repo
git remote add origin https://aidaho-edu.uni-hohenheim.de/gitlab/modellierung/modellierung_fitnessclub.git
git branch -M main
git push -uf origin main
```
- 2026 Thursday Sept 17 from 12:30 to 13:45
- 2026 Thursday Oct 15 from 12:30 to 13:45
- 2026 Thursday Nov 19 from 12:30 to 13:45
- 2026 Thursday Dec 17 from 12:30 to 13:45

## Integrate with your tools

* [Set up project integrations](https://aidaho-edu.uni-hohenheim.de/gitlab/modellierung/modellierung_fitnessclub/-/settings/integrations)
# Participate in the hands on workshop

## Collaborate with your team
To participate

* [Invite team members and collaborators](https://docs.gitlab.com/user/project/members/)
* [Create a new merge request](https://docs.gitlab.com/user/project/merge_requests/creating_merge_requests/)
* [Automatically close issues from merge requests](https://docs.gitlab.com/user/project/issues/managing_issues/#closing-issues-automatically)
* [Enable merge request approvals](https://docs.gitlab.com/user/project/merge_requests/approvals/)
* [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
- submit your sample dataset and modelling code (in the programming language of your
  choice) in a new issue at: [Insert issue page here]

## Test and Deploy
    - Make sure your csv file smaller than 10Mb. If the sample data is larger than 10Mb,
      please post it in a shared repository that can be accessed online, either publicly
      or through the university network, for example in an idaho repository. Then share
      that link in the issue

Use the built-in continuous integration in GitLab.
If the programming language is proprietary and requires a licence, please come with
your own laptop so that you can run the model in it's licenced environment.

* [Get started with GitLab CI/CD](https://docs.gitlab.com/ci/quick_start/)
* [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/user/application_security/sast/)
* [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/topics/autodevops/requirements/)
* [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/user/clusters/agent/)
* [Set up protected environments](https://docs.gitlab.com/ci/environments/protected_environments/)
At the beginning of each meeting we will vote on which project will be analyzed during
that meeting.

***

# Editing this README

When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.

## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.

## Name
Choose a self-explaining name for your project.

## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.

## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.

## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.

## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.

## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.

## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.

## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.

## Contributing
State if you are open to contributions and what your requirements are for accepting them.

For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.

You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.

## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.

## License
For open source projects, say how it is licensed.

## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.