Missing `unit.param` in docs

[chillenzer]

Probably this was an oversight from the refactoring of the unit system but there is an error message in the docs here: https://picongpu.readthedocs.io/en/latest/usage/param/core.html#unit-param

[BrianMarre]

unit.param was replaced by simulation.param bundling all definitions of a the simulation unit system in one place

[chillenzer]

Well caught!

[PrometheusPi]

@chillenzer is this still relevant or can the issue be closed?

[chillenzer]

This is still relevant. You can check this for yourself by following the link.

[Kushagra1480]

Hi! I see this issue has been assigned for a while with no recent activity. I'd like to help with this documentation fix if it's available. I can check the link and update the docs to reflect the unit.param → simulation.param change. Is this still available to work on?

[ikbuibui]

Hi @Kushagra1480 . Thanks for looking into this, documentation is very important and this issue is indeed still open and not on a high priority for anyone else right now. Feel free to help out with this fix, we are always happy to get PRs.

[chillenzer]

Hi, I would really appreciate some help on this! Thanks for the offer! If you need any guidance, don't hesitate to ask!

[Kushagra1480]

Hi @chillenzer! Upon reviewing the documentation, I've found that the unit.params path in ./usage/param/core.rst points to a directory that does not exist :path: include/picongpu/simulation_defines/param/unit.param. The unit.param file seems to be missing from codebase . The path error true for particelFilters.param as well but I presume the path mismatch is resolved by doxygen since this file does exist.

the include/picongpu/param dir looks like this

~/code/picongpu/include/picongpu/param   dev  ls -1 atomicPhysics_Debug.param atomicPhysics.param binningSetup.param collision.param density.param dimension.param fieldAbsorber.param fieldBackground.param fieldSolver.param fileOutput.param incidentField.param ionizationEnergies.param ionizer.param isaac.param iterationStart.param mallocMC.param memory.param particleCalorimeter.param particleFilters.param particle.param physicalConstants.param pngColorScales.param png.param precision.param pusher.param radiationObserver.param radiation.param random.param shadowgraphy.param simulation.param speciesAttributes.param speciesConstants.param speciesDefinition.param speciesInitialization.param species.param synchrotron.param transitionRadiation.param

Notice the absence of a unit.param file. I'd love some assistance on this, if possible! I could remove this broken link and all a disclaimer based on @BrianMarre's comment.

[chillenzer]

Hi, thanks for your efforts! Yes, I think the link (including the subsection unit.param it is in) can be removed from the documentation. It looks like the simulation.param already covers something about units but if you want to be extra sure you could check that the original information from unit.param's documentation (back when it existed) is well retained in the current simulation.param documentation.