Metadata-Version: 2.4
Name: mspass-launcher
Version: 0.1.0
Summary: A launcher for MsPASS on desktop and HPC clusters.
Author-email: "Gary L. Pavlis" <help@mspass.org>
License: BSD 3-Clause License
        
        Copyright (c) 2025, MsPASS Team
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Homepage, https://github.com/mspass-team/mspass_launcher
Project-URL: Repository, https://github.com/mspass-team/mspass_launcher
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyyaml>=5.1
Dynamic: license-file

# MsPASS Launchers
This repository contains a set of "launcher" that simplify launching MsPASS on different platforms.  MsPASS is normally run packaged in a docker container.  That has major advantages in consistency of results as it reduces platform dependencies in the code base.  The disadvantage it create is that working with the framework is different from most user experience.  We have learned it best to think of the framework as defined by four services run in containers:  
1.  A MongoDB database service
2.  A parallel scheduler (dask or pyspark)
3.  One or more parallel worker instances
4.  A "frontend" that will run jupyter notebooks or python scripts directly.

The original bare-metal mspass repository has only some awkward shell script methods to launch MsPASS on HPC systems and a CLI docker incantation to run the package on Desktops.  The purpose of this repository is to provide simpler to use and maintain launchers for different platforms.  The current repository has support for two setups:
1.  A main program called `mspass_desktop` launches a simple graphical user interface to launch the package.   A section of the mspass User's manual is under construction to provide simple instructions for using this (python) program.
2.  In python/mspass_launcher is a module called `HPCClusterLaucher.py`.   It can be used to simplify running MsPASS on HPC systems in batch mode.  It is driven by a configuration file that needs to be customized for a given site and processing set to controll how many workers a job will need to run.  Again, a section in the User's Manual is under construction to describe how to use HPCLauncher.

In addition, we expect to eventually add a launcher to simply running MsPASS on cloud systems like Amazon Web Services where Earthscope is in the process of moving their seismic data archives.   That will not appear, however, until Earthscope has a stable environment for interaction with the archive.  
