Update README.md

[MichaelTiemannOSC]

Going through the process to get SoSTrades working on an OSX Mac (14.3.1), I can report the following:

For step 6, brew install jq works for me (with xcode command line tools installed and a brew environment installed)

For 3.1 Prerequisites, I downloaded the latest version of Docker (Docker version 25.0.3, build 4debf41) and it works.
But with that latest version, to get the version number of docker compose, the command is docker compose version not docker compose --version. The reported version is Docker Compose version v2.24.5-desktop.1

3.4 invites the user to start and play with the Web UI. I suggest that here, or in a later 3.5 or 3.6 you mention the following things I discovered (with help from the SoSTrades team):

From the "hamburger" menu, select Reference Management
In the filter, search for story
In the rightmost column (to the right of creation date), regenerate the references
From the "hamburger" menu, select Study Management
Create a New Study with a name you choose
For the Process Name, select WITNESS Coarse Dev Multi-Scenario Story Telling mda Process Climate Economics - WITNESS Repository
For the Study Name, choose your preferred study (e.g. usecase_witness_ms_mda)
For the Group Name, choose whether to make the study available to all users or SoSTrades-Dev.

After some minutes, a new study will appear
From the root of that study, you can press the Play button to begin the process of calculations
After some minutes, the status of the study will change from P (pending) to D done.
You can then pick a specific scenario (e.g. + damage -tax, fossil 100% from the mda_scenarios child of the study.
You can then visit graphs of the result in the Post Processing tab.

Note that at present, scenarios listed with - damage as the prefix encounter a fault that is not your fault.

[MichaelTiemannOSC]

I should also add that if the developer wants to run in the local (not a docker) environment, then petsc is needed. This can be installed on OSX using brew install petsc. It installs version 3.20, not version 3.19.

[ggoyon]

I should also add that if the developer wants to run in the local (not a docker) environment, then petsc is needed. This can be installed on OSX using brew install petsc. It installs version 3.20, not version 3.19.

We are working on making the installation of PETSC optional and configurable as it brings some issues for some systems (like Windows)
This will be documented

[sostrades-pjbarjhoux]

Hi @MichaelTiemannOSC,

Many thanks for your feedback, this brings strong added value to the project.

We have indeed ongoing work on several points you mentionned, regarding documentation improvements, local deployment robustness (involving PETSc) as well as WITNESS studies post processing robustness.

Concerning the post processing issue, we are pleased to inform you that the development team managed to fix it. The fix is now available on the validation branches and validation platform. You can either :

• check the updated study on the online platform here for example,
• or update your local platform by pulling the code changes from models repositories (into ./sostrades-dev-tools/models/witness-core and ./sostrades-dev-tools/models/witness-energy ) and running docker compose up.

We keep you updated regarding the other points you mentionned.

[sostrades-pjbarjhoux]

Local installation documentation has been updated and migrated to sphinx and deployed with readthedoc :
local platform installation link

A documentation on the use of the core execution engine (sostrades-core repository) has also been initiated and covers main principles to build a model and create a process.
core execution engine documentation link

[MichaelTiemannOSC]

One comment about the screenshots on the readthedocs.io site: I think the screenshots need more resolution because resolution is lost in the screen capturing process. When I scale up the size of my window, the screen captures are not very clear.