Installation and documentation feedbacks
This issue lists all comments formulated by @braffin concerning the installation/execution of Melissa.
To-Do
- Installation
-
"Python 3.9 requirement is strong" -> identify the lowest compatible version (my local installation works with Python@3.8.10
):
Melissa was successfully installed and executed (heat-pde-sa) on Grid5000 (Lille site) with Python@3.7.15
-
CMakeLists.txt
comments and options need clarification and cleaning (Spack MR initiates these changes)
The new installation procedure places melissa
sources in the install
folder and the pseudo-executables (melissa-launcher
and melissa-server
) in install/bin
. Note that all requirements are installed in .local
and are hence potentially available for multiple installations.
-
install examples in install/share folder.Add to doc that users can work out of this location?
- Documentation
-
highlighting the fact that OpenMPI
is not a scheduler -
show user how to add custom parameters to config file and how that ends up translated to server -
explain the squeue files in doc -
"No pytorch dep mentioned." -> just add a note in install page saying "if you want DL you need these also installed" -
wrong links in JOSS paper (e.g. the getting started section does not exist anymore)
To-Discuss
"Doc: missing the melissa-dep.sh to setp up all env variables (PATH)" -> to be discussed-
"have a self contained melissa install" -> installingPut the install inmelissa-launcher
andmelissa-server
ininstall/share
? -> to be discussed,install/bin
"have a getting started that ends with an example that you can check" or "add an option in Cmake to build the examples" -> to be discussed- "The configuration file [...] must be edited at least to update the path to the executable. Why not processing it with cmake" -> to be discussed
server.sh
andclient.sh
are never edited by user. User only ever touches config (add preprocessing commands) and server filesWhat are "customized configs?"- "oversubscribe option explanation not clear/correct" -> rewrite explanations
Heat-PDE specifics
-
merge both heat-pde folders into a single one with the following structure:
.
+-- `heat-pde/`
+-- `executables/`
+-- `CMakeLists.txt`
+-- `heat.c`
+-- `heat.f90`
+-- `heat_no_melissa.c`
+-- `heat_utils.f90`
+-- `heat-pde-sa/`
+-- `configs`
+-- `heatpde_sa_server.py`
+-- `plot-result-sa.py`
+-- `heat-pde-dl/`
+-- `configs`
+-- `heatpde_dl_server.py`
+-- `offline-example/`
+-- `plot-result-dl.py`
-
control parameter range of variation from the config files -
enhance comments to reduce the number of config files heat-pde (DL): option to control the output instead of two executables
Launcher specifics
-
"melissa-launcher --help" -> clean launcher argparse -
"why not a scheduler class instead of having everything in the main + no template" -> clean __main__.py
to make it more readable - "Do we really need the project dir" -> to be discussed
-
"Version: return melissa version. Do we distinguish the different component versions ?" -> to be discussed -
"Crash (because use .json extension)" -> improve help comment? to be discussed -
"Launcher should output the result/log dir for info" (doesnt the splash screen do this already with the monitor command?) -
"Why it writes in big MELISSA SERVER" -> to be replaced with MELISSA LAUNCHER -
examine how to add help information/print config stuff using json validator -
remove project dir? use relative paths
melissa-monitor
-
install melissa-monitor
as a package
create element chatroom for dev
-
make account setup server