Some revisions

[brendankeith]

No description provided.

[jorgensd]

Lgtm

[brendankeith]

More coming. Not ready for review yet!

[brendankeith]

The names of the folders and scripts within are confusing to outsiders.

I think we should rename the folders in https://github.com/METHODS-Group/ProximalGalerkin/tree/main/examples to example/example1,2,3,4,etc. We then need to come up with a convention for naming the files within.

We could use

• /examples/exampleX/script.py or
• /examples/exampleX/application_name.py (e.g., /examples/example1/obstacle.py, /examples/example2/signorini.py)

[brendankeith]

We also need to get rid of https://github.com/METHODS-Group/ProximalGalerkin/tree/main/examples/hyperelasticity, which contains code not used in the paper

[jorgensd]

The names of the folders and scripts within are confusing to outsiders.

I think we should rename the folders in https://github.com/METHODS-Group/ProximalGalerkin/tree/main/examples to example/example1,2,3,4,etc. We then need to come up with a convention for naming the files within.

We could use

• /examples/exampleX/script.py or
• /examples/exampleX/application_name.py (e.g., /examples/example1/obstacle.py, /examples/example2/signorini.py)

Let’s discuss naming once we have all the code.

[jorgensd]

We also need to get rid of https://github.com/METHODS-Group/ProximalGalerkin/tree/main/examples/hyperelasticity, which contains code not used in the paper

I’ll remove the folder completely in a separate PR.

[brendankeith]

This is ready for review!

[ioannisPApapadopoulos]

I don't agree with renaming the examples to 1,2,3.. I think it difficult for someone just looking at the repo to figure out what example is where and I think the point of the table is to point a reader of the paper to the relevant script for that section.

[brendankeith]

I don't agree with renaming the examples to 1,2,3.. I think it difficult for someone just looking at the repo to figure out what example is where and I think the point of the table is to point a reader of the paper to the relevant script for that section.

@thomas-surowiec and I discussed this topic this morning and would like to propose we number the subdirectories in the following way: 1_obstacle, 2_signorini, etc.

This way, the folders will always be listed in the order they appear in the paper, making it easier to find them than just having a keyword

What do you think @ioannisPApapadopoulos ?

[jorgensd]

Thinking about the table, should we just remove the File: examples/ column, or rename it to Example folder:, and point to the folder instead of a file? We could also move the descriptions into each individual folder, with a README, making the landing page slimmer.

[brendankeith]

All of these good ideas are fine with me

[ioannisPApapadopoulos]

@thomas-surowiec and I discussed this topic this morning and would like to propose we number the subdirectories in the following way: 1_obstacle, 2_signorini, etc.

This way, the folders will always be listed in the order they appear in the paper, making it easier to find them than just having a keyword

What do you think @ioannisPApapadopoulos ?

That sounds good!