Dev Environment: setup and the documentation for using the container

[Laurynas-Jagutis]

Setup of the Dev Container on the Python side only.
Also has the documentation on how to set it up.

The gitattributes file is for standardizing line endings to LF instead of CRLF

[TonyXiang8787]

Does the developer need to install two additional software (besides Docker) to use the Dev Container? I am hesitating about whether this actually brings convenience to the developers.

[mgovers]

just having docker desktop would also work (that's one tool instead of 2, but it's a paid service). Many python-only developers will have these tools installed anyways.

Devcontainers are especially useful for those python-only developers that have never worked with a C++ compiler but come from the IT industry in which containers are extremely common

[TonyXiang8787]

In that case, please take container into account for macOS.

https://github.com/apple/container

It is the preferred container engine.

[figueroa1395]

I was able to install everything and launch the container through VScode, but I'm having trouble with python and pip. My hunch is that something went wrong because of MacOS. @Laurynas-Jagutis Let's see if we can resolve the issue together.

[figueroa1395]

I was able to install everything and launch the container through VScode, but I'm having trouble with python and pip. My hunch is that something went wrong because of MacOS. @Laurynas-Jagutis Let's see if we can resolve the issue together.

After diving into the issue together with @Laurynas-Jagutis, we found that there were two issues:

1. One must set the container from the correct branch (this branch and not main - my mistake).
2. On MacOS (and perhaps other machines) podman has the default RAM of the containers set to a very small value, not enough to build PGM. This is very easy to solve by increasing the RAM from podman itself.

Both points will be added to the documentation, but I can now confirm that this approach works well for MacOS as well.

[TonyXiang8787]

I was able to install everything and launch the container through VScode, but I'm having trouble with python and pip. My hunch is that something went wrong because of MacOS. @Laurynas-Jagutis Let's see if we can resolve the issue together.

After diving into the issue together with @Laurynas-Jagutis, we found that there were two issues:

1. One must set the container from the correct branch (this branch and not main - my mistake).
2. On MacOS (and perhaps other machines) podman has the default RAM of the containers set to a very small value, not enough to build PGM. This is very easy to solve by increasing the RAM from podman itself.

Both points will be added to the documentation, but I can now confirm that this approach works well for MacOS as well.

@figueroa1395 please try container app from Apple for dev container in MacOS, instead of podman/devpod

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[mgovers]

please do not blindly set * text=auto. You can refer to https://stackoverflow.com/questions/21472971/what-is-the-purpose-of-text-auto-in-gitattributes-file

What's the reason you needed this in the first place?

[figueroa1395]

I was able to install everything and launch the container through VScode, but I'm having trouble with python and pip. My hunch is that something went wrong because of MacOS. @Laurynas-Jagutis Let's see if we can resolve the issue together.

After diving into the issue together with @Laurynas-Jagutis, we found that there were two issues:

1. One must set the container from the correct branch (this branch and not main - my mistake).
2. On MacOS (and perhaps other machines) podman has the default RAM of the containers set to a very small value, not enough to build PGM. This is very easy to solve by increasing the RAM from podman itself.

Both points will be added to the documentation, but I can now confirm that this approach works well for MacOS as well.

@figueroa1395 please try container app from Apple for dev container in MacOS, instead of podman/devpod

I will try as soon as I have the time and report back.