topic Re: [PYTHON] Sum area script in Archicad Python API

[PYTHON] Sum area script

Mathias Jonathan — Mon, 27 Feb 2023 13:15:39 GMT

Hi everybody!

I developped a python script that sum the zone area with the help of Poco.

The script sum all zone of the same zone number and put the result in a custom property. You just have to retrieve the value with a label (example file in the zip).

The custom property has to be to string type.

The scrip uses the measured area.

Re: [PYTHON] Sum area script

Mathias Jonathan — Mon, 20 Mar 2023 15:04:50 GMT

Hi everybody.

Here is an update of the script:

-Add the possibility to choose more than one layer

-Add the possibility to choose zone category codes instead of layers

-Add parameters for the use of calculated area or measured area, shown or real values.

Re: [PYTHON] Sum area script

Karl Ottenstein — Mon, 20 Mar 2023 16:53:08 GMT

So many good things about your script, beyond your giving it to the Archicad community. I'm very impressed with your clear, readable code with meaningful variable names and ample use of comments throughout to explain what is happening - in both English and French. Even for someone who may not need this script for their work, I really think it serves as an excellent advanced Python-in-Archicad tutorial because of the clarity of your code.

I will say that, not having used Python in Archicad and having only looked at the 'baby' samples, the length of your script (800 lines) was at first surprising until I read the code.

Thank you for sharing this!

Re: [PYTHON] Sum area script

Mathias Jonathan — Tue, 21 Mar 2023 12:34:55 GMT

Thanks for the nice message Karl.

I started learning and coding in python to modify this script originally written by Poco (whom I would like to thank by the way!).

I didn't know anything about Python at the time, and had only coded small objects in GDL until now.

There have been many iterations on this script, and it has been heavily reviewed by Poco who proposed many corrections to make the code cleaner.

The script part allowing to do the calculations is in itself quite short.
What makes it heavy are the comments as you pointed out, but especially the interface with Tkinter.

I was impressed by the possibilities of the python-archicad connection, even if it is still quite limited.

We can easily imagine functions coded by experienced users but used by users not initiated to code (thanks to the GUI), which makes the thing very interesting

I think that I will continue my tutorials on the archicad-python so that anybody can code this kind of script.

Re: [PYTHON] Sum area script

Dawid — Fri, 17 Nov 2023 06:47:44 GMT

Great job!

Re: [PYTHON] Sum area script

magdak — Mon, 10 Jun 2024 13:05:31 GMT

Hi, I don't know programming but I would like to learn how I could combine this script with another python script or use them both,

- 1st one is to sum up areas by zone number like shown in this post

- 2nd to measure % of areas with exact zone number according to a zone sum that will be taken as 100%

Here is better explanation what I mean:

And get something in table like this:

I am doing it in archicad but here I cannot set zone number property to get 100% into table, so I thought one can achieve it with Python.

Better explanation of the problem I run into - various 100% plots in a project:

I would need to define each plot area in Python as 100% for its zone number and then execute calculation of %, I thought it would be easy operation but I am having problem applying this in python script.

Would be grateful for any help! Thank you

Re: [PYTHON] Sum area script

Mathias Jonathan — Fri, 07 Jun 2024 12:30:39 GMT

@magdak It seems possible, and the sum area script seems to be a good start. You'll have to study the code that is heavily commented

@Everybody: I updated the script in order to give feedback to the user: why the script didn't work, how to help correct it. All the feedback will appear ine the python console , like this :

If you used or like this script, please vote for any Python wish on the forum!

We need more development on it!

Re: [PYTHON] Sum area script

pr3 — Wed, 28 Aug 2024 09:46:16 GMT

Hello Mathias!

Very big thank you for providing this script for free. I was struggling with a solution and with the archicad zone stamp tool for years. This solves nearly everything I could hope for.

If I may add one small wish if you still work on updating the script:

Could you add the option to select a custom property for the type of area to be used for calculation?

We sometimes need to use a reducing factor for certain room areas and we can only do this by using a custom property for calculating.

Would be very much appreciated!

Re: [PYTHON] Sum area script

LucaP — Wed, 28 Aug 2024 21:41:02 GMT

Hi pr3,

If the factor you're talking about is a percent value then you can do that directly in the Zone Tool.

Just use the "Reduce by:" field in Zone settings. (Keep in mind that you have to Update Zone for the reduction to take effect!).

Then just select Calculated Area in that marvelous tool that Mathias has created.

Below you can find the location of that setting:

Re: [PYTHON] Sum area script

pr3 — Wed, 28 Aug 2024 11:06:27 GMT

I know you could do it this way but for some reason we abandoned this a few years ago and did id with a calculated property.

I just tired it now and it works just fine...

Thank you 😉

Re: [PYTHON] Sum area script

LucaP — Wed, 28 Aug 2024 11:15:19 GMT

Glad it worked!

There's nothing wrong with using a calculated property to be honest, if you're keeping track of all the created Properties when working with multiple files regarding one project. It can be a nightmare... That's why I tend to minimize the number of Custom Properties and try to find a way to use built-in solutions.

I'm still waiting for Graphisoft to address the need to have a centralized file for Attributes, Properties etc. across multiple files. Ability to create Company Standard Files is something I'm really hoping to get resolved soon.

Re: [PYTHON] Sum area script

pr3 — Wed, 28 Aug 2024 11:19:05 GMT

Well as long as Graphisoft continues to add new features that barely make it to 80% done in the first place and

never updates the old features and removes any bugs I just lost hope at this point.

Thats what brought me here in the first place because the zone stamp tool is a real nightmare.

Re: [PYTHON] Sum area script

magdak — Tue, 08 Oct 2024 16:05:06 GMT

I really hoped Archicad 28 could count % of areas with new update! 😅 Without need of learning to code in Python 😓

Re: [PYTHON] Sum area script

Mathias Jonathan — Wed, 09 Oct 2024 08:01:18 GMT

I think that even if graphisoft offer a new tool, it won't be able to answer 100% of our worflow on the matter, it is so diverse!

Re: [PYTHON] Sum area script

Mathias Jonathan — Wed, 04 Jun 2025 07:31:30 GMT

Hello everyone,

New version of the script!

I updated my sum area script (it puts the sum of all area with the same identifier in a custom property in each of the affected zones).

I also made a "translation" system : the script will check the language code (FRA for the french version for example) and will verify if there is a corresponding file in the parameters folder. For example, translations_FRA for the french version, and will use this file to change the script language.

I strongly advise you to install the opensource/free Tapir plugin for archicad, which provides a palette to launch the script, here: https://github.com/ENZYME-APD/tapir-archicad-automation?tab=readme-ov-file#archicad-add-on

New in V3:

-New option: only takes into account zones with a certain custom property value.
-New interface that automatically loads previously used parameters.

New option: three script launch modes: silent, light pop-up (number of zones updated), full report (for debugging/verification) but slow.

Here is a little video presentation:

Re: [PYTHON] Sum area script

magdak — Fri, 06 Jun 2025 17:29:37 GMT

Hi, thank you a lot for providing the updated script 😍

I run into a problem, probably you could explain to me what I am missing... I created a custom property for Zones with the name Total and string data type

but after running a script, I don't get the sum value automatically added to that property... what could be the problem? The classification is attached to zones.

Is it because of no translation for my language?

These are the results I expected to see in the Total property:

Another thing, do you think is it possible and not so hard to exchange these 2 parameters?

So the script sums up all zones according to the zone category code doing so for all zone numbers... so i.e. all categories 02 with number 1 give the sum

Thank you in advance for help🙏

Re: [PYTHON] Sum area script

Mathias Jonathan — Thu, 05 Jun 2025 15:14:09 GMT

I don't intend to add this precise workflow to the script, but you probably could use custom properties to achieve the same result:

-Custom property for the apartment number, retrieving category code

-Selecting all layers or categories in the zone/layer part

-Use a custom property in the "additional Zone selection Parameter(Advanced Parameters). This custom property could be True False : If Category code is 01,02 or 03 then true; if not, then false.

Do you have an error in the archicad report window after clicking on the apply changes button? Can you share the report?

Re: [PYTHON] Sum area script

magdak — Fri, 06 Jun 2025 17:43:11 GMT

After I click on apply changes I get:

And the number appears in the total property now, but I don't know how to attach it onto the label for each zone...

How do you get for each zone type different amount of Total on the label?

Re: [PYTHON] Sum area script

Mathias Jonathan — Fri, 06 Jun 2025 07:42:57 GMT

@magdak wrote:

And the number appears in the total property now but I don't know how to attach it onto label for each zone...

How do you get for each zone type different amount of Total on the label?

I don't really understand. How do I display the total in plan? I'm using a classic text/autotext label that retrieve the custom property.

You can use the script with different settings and tell the script to put the result in 2 or more different custom properties. Then, you juste have to update your label to retrieve those 2+ custom properties.

Re: [PYTHON] Sum area script

magdak — Fri, 06 Jun 2025 08:33:39 GMT

Ohh, I forgot I have basic zone stamp that didn't offer this label property. When I change it to the complex zone stamp then it works well...

but is it possible to get these each stamps onto the layout? To make a Table there with all Totals listed together.