Documentation - How should the changes logs be read in the official IFC4X3_ADD2 documentation?

buildingSMART / IFC4.x-IF

IFC4.x Implementers Forum

28 stars 33 forks source link

Documentation - How should the changes logs be read in the official IFC4X3_ADD2 documentation? #142

Closed gmn3DS closed 3 months ago

gmn3DS commented 5 months ago

Hello everybody,

The title is quite self-explanatory but I am having trouble understanding the change logs. Against which prior version should they be regarded?

( I think my confusion might stem from the presence of IFC 4.1 and IFC 4.2 logs since both schema have been withdrawn. )

Best regards, Guillaume

aothms commented 5 months ago

Within the sequence of schema IFC2X3_TC1 IFC4_ADD2_TC1 IFC4X1 IFC4X2 IFC4X3_ADD2 the change logs are given relative to the previous in this list.

You can use https://github.com/buildingSMART/IFC4.3.x-development/blob/master/code/change_log.py to generate a changelog yourself for a schema pair of interest.

gmn3DS commented 4 months ago

Hello @aothms,

So I spent some time trying to use change_log.py, without success. For the record (Python 3.11.1 win10-64), I realized the following steps:

Cloned the repository IFC4.3.x-development and replaced content from (same) zipped repository. (It solved one of my issues)
Install the requirements (in a python virtual environment)
Install ifcopenshell pre-built package according to my configuration
Install lark library because it seemed to be missing from the requirements

I am currently struggling with the following error:

More than me overcoming the environment setup, I guess it would be natural to have change logs between official ISO schema. My suggestion is to add change logs between IFC4_ADD2_TC1 and IFC4X3_ADD2 to the unofficial documentation, would that be possible?

Thanks, Guillaume

aothms commented 4 months ago

The files in ./reference_schemas/ come with their own 'pickled' variants, because parsing from text is rather slow.

afbeelding

My guess is that these were created using an older (or at least) different version of pyparsing than the one you installed. I see the version installed on the documentation server is pyparsing==2.4.7.

I'd advise you either try pip install pyparsing==2.4.7 or del .\reference_schemas\*.dat.

Edit: other than that I think it makes sense if we build a feature to allow the user to compare between any two versions in the HTML frontend.

evandroAlfieri commented 3 months ago

Closing and continuing in https://github.com/buildingSMART/IFC4.3.x-development/issues/785