Rich console width

[dbochkov-flexcompute]

Here's how we can adjust width of rich output, so that it should eliminate horizontal scroll bars in web documentation. Perhaps an alternative that we can consider is to define this width in the config, so that it could be changed as needed? What do you think? @tylerflex @momchil-flex

[tylerflex]

Looks good. This will be great.

What worries me slightly is remembering to pass width=CONSOLE_WIDTH in the future for all progress bars or consoles.

Would it make sense to define a console instance in log.py and import that?

console = Console(width=CONSOLE_WIDTH)

or alternatively, if we need to make a new console each time, we could try:

# log.py
def make_console(*args, **kwargs):
    if "width" not in kwargs:
        kwargs["width"] = CONSOLE_WIDTH
    return Console(*args, **kwargs)

and call that function in the webapi?

[dbochkov-flexcompute]

yeah, that sounds better. In fact, internally rich has a similar logic https://github.com/Textualize/rich/blob/master/rich/__init__.py#L23-L36. Probably we can just use it whenever we need a console, just call rich.reconfigure(width=CONSOLE_WIDTH) somewhere during tidy3d initialization

[dbochkov-flexcompute]

So, I realized we already create a console instance inside our logger, and decided just to retrieve it anytime we need a rich console. Do you see any issues with that?

[tylerflex]

Not specifically. As long as it works properly when running different notebooks for example it should be fine. For example if notebook A and B are running simultaneously, their outputs shouldn't get mixed up

[dbochkov-flexcompute]

Yeah, doesn't seem to break anything. Just noticed that rich.track() should also be given a console, added that.

This is what I get after compilation of html. Maybe we should also consider setting code width to 80 when black'ing notebooks

[tylerflex]

Looks good! Thanks! just a minor comment to explain the CONSOLE_WIDTH variable for future reference and also could you add a CHANGELOG item? Thanks!

[tylerflex]

can you just add a comment above this saying that

# Width of the console used for rich logging (in characters).

[momchil-flex]

Can you just double check that the logging level and verbose in web functions are still independent from one another. I think they should be but just to make sure.

[tylerflex]

I'm excited to see the newly rendered docs after this fix :D