JupyterLab notebook for Tracking and Installing PyRoll Packages

[ToFFmashines]

Hi PyRoll Team,

First of all, thank you for all your work on this excellent project!

I’d like to share a script I’ve developed for managing PyRoll packages, which I’ve already tested on both my work and home computers. I created it mainly to keep track of which PyRoll-related packages (and versions) I am currently using across different environments.

Script Features:

🧾 Check, List Versions, and Install PyRoll Packages

This script is designed for working with PyRoll project packages. It is intended for use in a JupyterLab environment and includes the following steps:

✅ What the Script Does:

1. Finds all packages starting with pyroll- on PyPI.

2. Identifies which of them are currently installed in the active Python environment.

3. Displays a list of installed packages and their versions.

4. Retrieves available versions for packages that are not installed.

5. Separates them by major version (3.x and 2.x).

6. Creates clear tables:

   • ✅ Packages available in version 3.x
   • ✅ Packages available in version 2.x
   • ⚠️ Packages that only have 2.x (no 3.x available)

7. Generates pip install commands:

   • for installing all packages with the latest 3.x version
   • for installing packages available only in version 2.x

---

📌 Usage:

• Compatibility analysis when transitioning between PyRoll versions.
• Planning installation of required plugins.
• Maintaining the environment for rolling simulations.

🔧 The script does not automatically install any packages. It only displays suggested pip install ... commands that can be run manually.

Here is the notebook for JupiterLab
list-pyroll-all-repo-en.zip

If anyone is interested, I’m happy to share the script and would appreciate any feedback or suggestions for improvement!

Best regards,
Tomas Kubina

[ToFFmashines]

After testing on another PC, I made the following improvements.

Note / Changelog

• Replaced deprecated pkg_resources with the modern importlib.metadata API for detecting installed packages.
  This ensures compatibility with current and future Python versions and removes deprecation warnings.
• Added an interactive option to manually disable SSL certificate verification before running any requests.
  This allows the script to connect to endpoints with invalid or self-signed SSL certificates if needed.

Last version
list-pyroll-all-repo-en.zip

Tomas Kubina

[QiangF]

Nice work. Ideally the pyroll project should all reside in one repo, then to get the latest is just one command away. Most of the repo has only a few small files, it is really unnecessary to split into so many repos.

[ChRen95]

Thanks for the script I hope it helps users.
Do you use a global installation for pyroll or do you use a virtual environment (e.g. pipenv, hatch or uv)?

@QiangF
Well we had everything in one repo back in the really early days. But the modular concept of plugins and core demands maintaining everything separately. That's also the reason we we created a metapackage (pyroll-basic) witch directly installs all necessary modules to run a basic simulation.
How do you use pyroll?

[ChRen95]

Well the reason for that is quite simple, we don't want to put single changes into a new release except there is a bug in the current version.
Users from industry often have difficulties to update pyroll as they don't have admin rights in their computers.

Yes you're right that sort of some modules are related to others but to keep pyroll flexible and modular the chosen path is the most suitable in our opinion.
If you download the modules from pypj you will also notice, that every module will be put into the same "pyroll" folder automatically.

Further, as we for example provide separate models and methods to calculate the material flow inside the roll gap, you can't use all modules together.

[ChRen95]

@ToFFmashines "pyroll-asymetric" sounds nice but is still quite a challenge. As you may have seen we are a small team of developers that work on the project but that's certainly our goal to be able to do that in the future. We hope that with pyroll 4.0 we will be able to model angles and beams but also this is currently in development.

@sag-kalibreur nevertheless prepares a presentation for the AIKW conference this year in how to use pyroll for asymmetric profiles.

[sag-kalibreur]

@QiangF - @ToFFmashines - @ChRen95

Very nice work and a helpful script for keeping track of the PyRolL modules. I'm just afraid that the query will be blocked by the firewall on industrial computers. Console access via pip, such as pip list --outdated, is enabled, however. I'll test it at work, though; it works fine at home. I'll let you know how it goes.

Perhaps a small improvement. Since normally not all ‘missing’ PyRolL packages are installed – only the ones that are needed – I would find a table view of "pip install command for 3.x versions” more suitable.

I have modified it for myself as follows:

# -- Make pip install commands
if not df_3x.empty:
    df_3x['pip install'] = df_3x.apply(lambda row: f"{row['Package']}=={row['Latest 3.x Version']}", axis=1)
    display("### 📥 `pip install` command for 3.x versions")
    cmds = "\n".join(f"- `pip install {cmd}`" for cmd in df_3x['pip install'])
    display(Markdown(cmds))

The AIKW presentation on asymmetrical profiles will be more of a lecture from an industrial perspective on the integration of relatively simple full-section profiles into existing production lines. Of course, the scientific approach with PyRolL will also be demonstrated...

[sag-kalibreur]

@QiangF - @ToFFmashines - @ChRen95

Update:

The script also works on my office computer – very well :-)
I changed "pip install commands for 3.x versions" to a pandas table instead of a markdown table.

# -- Make pip install commands as a pandas table
if not df_3x.empty:
    df_3x['pip install'] = df_3x.apply(lambda row: f"pip install {row['Package']}=={row['Latest 3.x Version']}", axis=1)
    display(Markdown("### ?? `pip install` commands for 3.x versions (as pandas table)"))
    display(df_3x[['Package', 'Latest 3.x Version', 'pip install']])

[ToFFmashines]

@ToFFmashines "pyroll-asymetric" sounds nice but is still quite a challenge. As you may have seen we are a small team of developers that work on the project but that's certainly our goal to be able to do that in the future. We hope that with pyroll 4.0 we will be able to model angles and beams but also this is currently in development.

Yes, I understand that it's not an easy task. Unfortunately, I'm not skilled enough to contribute to the coding, but I would be happy to help with testing. I really appreciate the work you are putting into the project. It’s impressive how much can be achieved even by a small team when there’s dedication and expertise. Thank you for your efforts!

Is there any way to see the current status of pyroll 4.0 development? I would like to follow the progress and maybe help with testing new features.

@sag-kalibreur nevertheless prepares a presentation for the AIKW conference this year in how to use pyroll for asymmetric profiles.

I hope I’ll be able to attend and watch the presentation. In the meantime, I found the files @sag-kalibreur shared here in the discussion. I’m gradually working through the steps, though my progress is a bit slower over the summer holidays. :-)