search

uw-comphys / opencmp

OpenCMP is a computational multiphysics software package based on the finite element method. It is primarily intended for physicochemical processes involving significant convective flow.
https://opencmp.io/
GNU Lesser General Public License v2.1
25 stars 15 forks source link

Pull Request May 26 by MPT #28

Closed mptino closed 2 years ago

mptino commented 2 years ago

CHANGES

Setup.cfg - automatic required dependency installation and entry point support. Entry points are command line accessible tools. Now users can do opencmp config instead of python3 -m opencmp config to run the module.

Entry_points.py contains the functions for the entry points found in setup.cfg.

Installation_guide.rst. Found in Docs -> getting_started -> installation_guide.rst. Drastically changed to contain new installation information based on entry point functionality as well as WSL support for OpenCMP. Guidelines for each OS (Linux, Windows, macOS) also updated for OpenCMP usage on these platforms.

nasserma commented 2 years ago

Adding an issue to handle dependencies of "extra" functionality (building documentation and unit tests) using setuptools with extras_require keyword. This is not such a clear thing to do since we are using setup.cfg instead of setup.py (as a best practice).