search

GEOUNED-org / GEOUNED

A tool to convert CAD to CSG & CSG to CAD for Monte Carlo transport codes
European Union Public License 1.2
56 stars 30 forks source link

Adding command line tool including documentation and testing #155

Closed shimwell closed 4 months ago

shimwell commented 4 months ago

This PR adds a command line tool called geouned_cadtocsg

I've updated the pyprojects.toml scripts section to identify the command line tool file and function which takes care of installing the command line tool.

The command line interface it self is very concise thanks to the use of arg parse to and json to handle the file format and user command line arguments.

I've added a few lines to the CI that run the command line tool so this checks that it gets installed as part of the package. This is nice as it is available in any folder once geouned is installed.

I've added documentation showing how to use the command line tool and how to construct as JSON file with the correct format

shimwell commented 4 months ago

Ready for review whenever anyone has time