flecsi-skeleton 0.0.0__tar.gz

flecsi_skeleton-0.0.0/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.4
+Name: flecsi_skeleton
+Version: 0.0.0
+Summary: Generate skeleton FleCSI-based application projects.
+Author-email: Ben Bergen <bergen@lanl.gov>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://flecsi.org
+Project-URL: Source, https://github.com/flecsi/flecsi
+Project-URL: Issues, https://github.com/flecsi/flecsi/issues
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+
+# FleCSI Skeleton Package (skelf)
+
+## Create Python Environment
+
+The best way to build this package for development is to create a python
+environment:
+```shell
+$ python -m venv --prompt skelf-devel .venv
+$ source .venv/bin/activate
+$ pip install build twine
+```
+Then you can build like:
+```shell
+$ pip install -ve .
+```
+
+## Publish
+
+```shell
+$ twine upload dist/*
+```

flecsi_skeleton-0.0.0/README.md

@@ -0,0 +1,21 @@
+# FleCSI Skeleton Package (skelf)
+
+## Create Python Environment
+
+The best way to build this package for development is to create a python
+environment:
+```shell
+$ python -m venv --prompt skelf-devel .venv
+$ source .venv/bin/activate
+$ pip install build twine
+```
+Then you can build like:
+```shell
+$ pip install -ve .
+```
+
+## Publish
+
+```shell
+$ twine upload dist/*
+```

flecsi_skeleton-0.0.0/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "flecsi_skeleton"
+version = "0.0.0"
+description = "Generate skeleton FleCSI-based application projects."
+readme = "README.md"
+requires-python = ">=3.9"
+license = "BSD-3-Clause"
+authors = [{ name = "Ben Bergen", email = "bergen@lanl.gov"}]
+
+[project.scripts]
+skelf = "flecsi_skeleton._internal.main:main"
+
+[project.urls]
+Homepage = "https://flecsi.org"
+Source = "https://github.com/flecsi/flecsi"
+Issues = "https://github.com/flecsi/flecsi/issues"
+
+[project.optional-dependencies]
+dev = ["pytest>=7"]
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"flecsi_skeleton" = [
+  "_auxiliary_files/README.md",
+  "_auxiliary_files/app/*",
+  "_auxiliary_files/spec/*",
+  "_auxiliary_files/support/*"
+]

flecsi_skeleton-0.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

flecsi_skeleton-0.0.0/src/flecsi_skeleton/__main__.py

@@ -0,0 +1,7 @@
+import os
+import sys
+
+if __name__ = "__main__":
+    from flecsi_skeleton._internal.main import main as _main
+
+    sys.exit(_main)

flecsi_skeleton-0.0.0/src/flecsi_skeleton/_auxiliary_files/README.md

@@ -0,0 +1,33 @@
+# FleCSI Sandbox
+
+This skeleton project will get you started with building and running a
+FleCSI-based application.
+
+# Spack Environment
+
+Spack is the easiest way to build and run this example. You can install spack
+following the instructions
+[here](https://spack.readthedocs.io/en/latest/getting_started.html). Once you
+have sourced the appropriate script for your shell, you can create a spack
+environment like:
+
+```shell
+$ spack env create flecsi support/env.yaml
+```
+
+The contents of _env.yaml_ are similar to this content, which configures FleCSI
+with the Legion backend:
+
+```yaml
+spack:
+  specs:
+  - flecsi
+  packages:
+    flecsi:
+      require: '@2 +flog +graphviz +hdf5 backend=legion build_type=Debug'
+    legion:
+      require: 'network=gasnet conduit=mpi'
+  view: true
+  concretizer:
+    unify: true
+```

flecsi_skeleton-0.0.0/src/flecsi_skeleton/_auxiliary_files/support/env.yaml

@@ -0,0 +1,11 @@
+spack:
+  specs:
+  - flecsi
+  packages:
+    flecsi:
+      require: '+flog +graphviz +hdf5 backend=legion build_type=Debug'
+    legion:
+      require: 'network=gasnet conduit=mpi'
+  view: true
+  concretizer:
+    unify: true

flecsi_skeleton-0.0.0/src/flecsi_skeleton/_internal/fileutils.py

@@ -0,0 +1,12 @@
+from pathlib import Path
+from importlib.resources import files
+import textwrap
+
+def write(path: Path, content: str):
+    path.parent.mkdir(parents=True, exist_ok=True)
+    path.write_text(textwrap.dedent(content), encoding="utf-8")
+
+def copy_resource(src: str, dest: Path):
+    dest.parent.mkdir(parents=True, exist_ok=True)
+    content = files('flecsi_skeleton._auxiliary_files').joinpath(src).read_text()
+    write(dest / src, content)

flecsi_skeleton-0.0.0/src/flecsi_skeleton/_internal/main.py

@@ -0,0 +1,27 @@
+import sys
+from .options import *
+from .fileutils import *
+from .templates import *
+
+#-------------------------------------------------------------------------------#
+# Main
+#-------------------------------------------------------------------------------#
+
+def main():
+    args, dargs = parse_args()
+
+    write(args.root / 'CMakeLists.txt', TOPLEVEL_CMAKELISTS.format(**dargs))
+    write(args.root / 'spec' / 'CMakeLists.txt', SPEC_CMAKELISTS.format(**dargs))
+    write(args.root / 'app' / 'CMakeLists.txt', APP_CMAKELISTS.format(**dargs))
+
+    write(args.root / 'spec' / 'control.hh', CONTROL.format(**dargs))
+
+    write(args.root / 'app' / (args.name + '.cc'), DRIVER.format(**dargs))
+    write(args.root / 'app' / 'advance.hh', ADVANCE.format(**dargs))
+    write(args.root / 'app' / 'analyze.hh', ANALYZE.format(**dargs))
+    write(args.root / 'app' / 'finalize.hh', FINALIZE.format(**dargs))
+    write(args.root / 'app' / 'initialize.hh', INITIALIZE.format(**dargs))
+    write(args.root / 'app' / 'types.hh', TYPES.format(**dargs))
+
+    copy_resource('README.md', args.root)
+    copy_resource('support/env.yaml', args.root)

flecsi_skeleton-0.0.0/src/flecsi_skeleton/_internal/options.py

@@ -0,0 +1,26 @@
+from pathlib import Path
+import argparse
+
+#-------------------------------------------------------------------------------#
+# Command line arguments
+#-------------------------------------------------------------------------------#
+
+argParser = argparse.ArgumentParser()
+argParser.add_argument('name', help="the name of the project")
+argParser.add_argument('-p', '--path', action='store', dest='path',
+                       help="specify a path to the project"
+                       " default: current directory")
+
+def parse_args():
+    args = argParser.parse_args()
+
+    root = Path(args.path + '/' + args.name) if args.path else Path(args.name)
+
+    # Use argparse Namespace so that access can be like args.root
+    return argparse.Namespace(root = root, name = args.name), \
+        {
+            "ROOT" : root,
+            "UCC_APPNAME" : args.name.title(),
+            "LC_APPNAME" : args.name.lower(),
+            "UC_APPNAME" : args.name.upper()
+        }

flecsi_skeleton-0.0.0/src/flecsi_skeleton/_internal/templates.py

@@ -0,0 +1,346 @@
+#################################################################################
+# CMakeLists
+#################################################################################
+
+#-------------------------------------------------------------------------------#
+# Top-Level CMakeLists.txt
+#-------------------------------------------------------------------------------#
+
+TOPLEVEL_CMAKELISTS = """\
+#-------------------------------------------------------------------------------#
+# Top-Level CMakeLists.txt
+#-------------------------------------------------------------------------------#
+
+cmake_minimum_required(VERSION 3.20)
+
+project({UCC_APPNAME} LANGUAGES C CXX)
+
+set(CMAKE_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_EXTENSIONS OFF)
+
+#-------------------------------------------------------------------------------#
+# Find FleCSI package.
+#-------------------------------------------------------------------------------#
+
+find_package(FleCSI 2 REQUIRED)
+
+#-------------------------------------------------------------------------------#
+# Add library.
+#-------------------------------------------------------------------------------#
+
+set(SPEC_TARGET "${{CMAKE_PROJECT_NAME}}-Spec")
+add_library(${{SPEC_TARGET}} INTERFACE)
+add_library(${{SPEC_TARGET}}::${{SPEC_TARGET}} ALIAS ${{SPEC_TARGET}})
+target_include_directories(${{SPEC_TARGET}}
+  INTERFACE
+    $<BUILD_INTERFACE:${{CMAKE_CURRENT_SOURCE_DIR}}>
+    $<BUILD_INTERFACE:${{CMAKE_BINARY_DIR}}>
+    $<INSTALL_INTERFACE:${{CMAKE_INSTALL_INCLUDEDIR}}>
+)
+add_subdirectory(spec)
+
+#-------------------------------------------------------------------------------#
+# Add application.
+#-------------------------------------------------------------------------------#
+
+add_subdirectory(app)
+"""
+
+#-------------------------------------------------------------------------------#
+# Specialization CMakeLists.txt
+#-------------------------------------------------------------------------------#
+
+SPEC_CMAKELISTS = """\
+#-------------------------------------------------------------------------------#
+# Specialization CMakeLists.txt
+#-------------------------------------------------------------------------------#
+
+function(spec_headers)
+  target_sources(${{SPEC_TARGET}} PUBLIC FILE_SET public_headers TYPE HEADERS
+    BASE_DIRS ${{CMAKE_SOURCE_DIR}} FILES ${{ARGN}})
+endfunction()
+
+spec_headers(
+  control.hh
+)
+"""
+
+#-------------------------------------------------------------------------------#
+# Application CMakeLists.txt
+#-------------------------------------------------------------------------------#
+
+APP_CMAKELISTS = """\
+#-------------------------------------------------------------------------------#
+# {UCC_APPNAME} CMakeLists.txt
+#-------------------------------------------------------------------------------#
+
+option({UC_APPNAME}_WRITE_CONTROL_INFO
+  "Output the control model graph and actions at startup"
+  FleCSI_ENABLE_GRAPHVIZ)
+mark_as_advanced({UC_APPNAME}_WRITE_CONTROL_INFO)
+
+add_executable({LC_APPNAME} {LC_APPNAME}.cc)
+target_link_libraries({LC_APPNAME} ${{SPEC_TARGET}}::${{SPEC_TARGET}} FleCSI::FleCSI)
+
+if(FleCSI_ENABLE_GRAPHVIZ AND {UC_APPNAME}_WRITE_CONTROL_INFO)
+  target_compile_definitions({LC_APPNAME} PUBLIC {UC_APPNAME}_WRITE_CONTROL_INFO)
+elseif(NOT FleCSI_ENABLE_GRAPHVIZ AND {UC_APPNAME}_WRITE_CONTROL_INFO)
+  message(WARNING,
+    "{UC_APPNAME}_WRITE_CONTROL_INFO enabled but FleCSI not compiled with Graphviz")
+endif()
+"""
+
+#################################################################################
+# Specialization source
+#################################################################################
+
+#-------------------------------------------------------------------------------#
+# Control Model
+#-------------------------------------------------------------------------------#
+
+CONTROL = """\
+#ifndef SPEC_CONTROL_HH
+#define SPEC_CONTROL_HH
+
+#include <flecsi/flog.hh>
+#include <flecsi/run/control.hh>
+
+namespace spec::control {{
+/// Control Points.
+enum class cp {{
+  /// Application initialization.
+  initialize,
+  /// Time evolution (cycled).
+  advance,
+  /// Running analysis (cycled).
+  analyze,
+  /// Application finalization.
+  finalize
+}};
+
+inline const char *
+operator*(cp control_point) {{
+  switch(control_point) {{
+    case cp::initialize:
+      return "initialize";
+    case cp::advance:
+      return "advance";
+    case cp::analyze:
+      return "analyze";
+    case cp::finalize:
+      return "finalize";
+  }}
+  flog_fatal("invalid control point");
+}}
+
+struct control_policy : flecsi::run::control_base {{
+
+  using control_points_enum = cp;
+
+  /// Control Model Constructor
+  /// @param steps Maximum number of time steps.
+  /// @param log   Logging frequency.
+  control_policy(std::size_t steps, std::size_t log)
+    : steps_(steps), log_(log) {{}}
+
+  auto step() const {{ return step_; }}
+  auto steps() const {{ return steps_; }}
+  auto log() const {{ return log_; }}
+
+  static bool cycle_control(control_policy & cp) {{
+    return cp.step_++ < cp.steps_;
+  }}
+
+  using evolve = cycle<cycle_control, point<cp::advance>, point<cp::analyze>>;
+
+  using control_points =
+    list<point<cp::initialize>, evolve, point<cp::finalize>>;
+
+protected:
+  std::size_t step_{{0}};
+  std::size_t steps_;
+  std::size_t log_;
+}};
+}}
+
+#endif // SPEC_CONTROL_HH
+"""
+
+#################################################################################
+# Application source
+#################################################################################
+
+#-------------------------------------------------------------------------------#
+# Driver
+#-------------------------------------------------------------------------------#
+
+DRIVER = """\
+/*-----------------------------------------------------------------------------*
+  Driver (main function)
+ *-----------------------------------------------------------------------------*/
+
+// These import the action definitions.
+#include "advance.hh"
+#include "analyze.hh"
+#include "initialize.hh"
+#include "finalize.hh"
+
+/*
+  Headers are ordered by decreasing locality, e.g., directory, project,
+  library dependency, standard library.
+ */
+#include "types.hh"
+
+#include <spec/control.hh>
+
+#include <flecsi/runtime.hh>
+
+using namespace flecsi;
+
+int
+main(int argc, char ** argv) {{
+  // Output control model information.
+#if defined({UC_APPNAME}_WRITE_CONTROL_INFO)
+  {LC_APPNAME}::control::write_graph("{UC_APPNAME}", "cm.dot");
+  {LC_APPNAME}::control::write_actions("{UC_APPNAME}", "actions.dot");
+#endif
+
+  const flecsi::getopt g;
+  try {{
+    g(argc, argv);
+  }}
+  catch(const std::logic_error & e) {{
+    std::cerr << e.what() << ' ' << g.usage(argc ? argv[0] : "");
+    return 1;
+  }}
+
+  const run::dependencies_guard dg;
+  run::config cfg;
+
+  runtime run(cfg);
+  flog::add_output_stream("clog", std::clog, true);
+  run.control<{LC_APPNAME}::control>(10, 1);
+}}
+"""
+
+#-------------------------------------------------------------------------------#
+# Advance
+#-------------------------------------------------------------------------------#
+
+ADVANCE = """\
+#ifndef {UC_APPNAME}_ADVANCE_HH
+#define {UC_APPNAME}_ADVANCE_HH
+
+#include "types.hh"
+
+#include <flecsi/flog.hh>
+
+namespace {LC_APPNAME}::action {{
+
+void
+advance(control_policy & cp) {{
+  flog(info) << "Advance Action: " << cp.step() << std::endl;
+}}
+
+inline control::action<advance, cp::advance> advance_action;
+}}
+
+#endif // {UC_APPNAME}_ADVANCE_HH
+"""
+
+#-------------------------------------------------------------------------------#
+# Analyze
+#-------------------------------------------------------------------------------#
+
+ANALYZE = """\
+#ifndef {UC_APPNAME}_ANALYZE_HH
+#define {UC_APPNAME}_ANALYZE_HH
+
+#include "types.hh"
+
+#include <flecsi/flog.hh>
+
+namespace {LC_APPNAME}::action {{
+
+void
+analyze(control_policy & cp) {{
+  flog(info) << "Analyze Action: " << cp.step() << std::endl;
+}}
+
+inline control::action<analyze, cp::analyze> analyze_action;
+}}
+
+#endif // {UC_APPNAME}_ANALYZE_HH
+"""
+
+#-------------------------------------------------------------------------------#
+# Finalize
+#-------------------------------------------------------------------------------#
+
+FINALIZE = """\
+#ifndef {UC_APPNAME}_FINALIZE_HH
+#define {UC_APPNAME}_FINALIZE_HH
+
+#include "types.hh"
+
+#include <flecsi/flog.hh>
+
+namespace {LC_APPNAME}::action {{
+
+void
+finalize(control_policy & cp) {{
+  flog(info) << "Finalize Action" << std::endl;
+}}
+
+inline control::action<finalize, cp::finalize> final_action;
+}}
+
+#endif // {UC_APPNAME}_FINALIZE_HH
+"""
+
+#-------------------------------------------------------------------------------#
+# Initialize
+#-------------------------------------------------------------------------------#
+
+INITIALIZE = """\
+#ifndef {UC_APPNAME}_INITIALIZE_HH
+#define {UC_APPNAME}_INITIALIZE_HH
+
+#include "types.hh"
+
+#include <flecsi/flog.hh>
+
+namespace {LC_APPNAME}::action {{
+
+void
+initialize(control_policy & cp) {{
+  flog(info) << "Initialize Action" << std::endl;
+}}
+
+inline control::action<initialize, cp::initialize> init_action;
+}}
+
+#endif // {UC_APPNAME}_INITIALIZE_HH
+"""
+
+#-------------------------------------------------------------------------------#
+# Types
+#-------------------------------------------------------------------------------#
+
+TYPES = """\
+#ifndef {UC_APPNAME}_TYPES_HH
+#define {UC_APPNAME}_TYPES_HH
+
+#include <spec/control.hh>
+
+namespace {LC_APPNAME} {{
+
+using spec::control::control_policy;
+using control = flecsi::run::control<control_policy>;
+using cp = spec::control::cp;
+
+}}
+
+#endif // {UC_APPNAME}_TYPES_HH
+"""

flecsi_skeleton-0.0.0/src/flecsi_skeleton.egg-info/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.4
+Name: flecsi_skeleton
+Version: 0.0.0
+Summary: Generate skeleton FleCSI-based application projects.
+Author-email: Ben Bergen <bergen@lanl.gov>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://flecsi.org
+Project-URL: Source, https://github.com/flecsi/flecsi
+Project-URL: Issues, https://github.com/flecsi/flecsi/issues
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+
+# FleCSI Skeleton Package (skelf)
+
+## Create Python Environment
+
+The best way to build this package for development is to create a python
+environment:
+```shell
+$ python -m venv --prompt skelf-devel .venv
+$ source .venv/bin/activate
+$ pip install build twine
+```
+Then you can build like:
+```shell
+$ pip install -ve .
+```
+
+## Publish
+
+```shell
+$ twine upload dist/*
+```

flecsi_skeleton-0.0.0/src/flecsi_skeleton.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+README.md
+pyproject.toml
+src/flecsi_skeleton/__init__.py
+src/flecsi_skeleton/__main__.py
+src/flecsi_skeleton.egg-info/PKG-INFO
+src/flecsi_skeleton.egg-info/SOURCES.txt
+src/flecsi_skeleton.egg-info/dependency_links.txt
+src/flecsi_skeleton.egg-info/entry_points.txt
+src/flecsi_skeleton.egg-info/requires.txt
+src/flecsi_skeleton.egg-info/top_level.txt
+src/flecsi_skeleton/_auxiliary_files/README.md
+src/flecsi_skeleton/_auxiliary_files/support/env.yaml
+src/flecsi_skeleton/_internal/fileutils.py
+src/flecsi_skeleton/_internal/main.py
+src/flecsi_skeleton/_internal/options.py
+src/flecsi_skeleton/_internal/templates.py

flecsi_skeleton-0.0.0/src/flecsi_skeleton.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

flecsi_skeleton-0.0.0/src/flecsi_skeleton.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+skelf = flecsi_skeleton._internal.main:main

flecsi_skeleton-0.0.0/src/flecsi_skeleton.egg-info/requires.txt

@@ -0,0 +1,3 @@
+
+[dev]
+pytest>=7

flecsi_skeleton-0.0.0/src/flecsi_skeleton.egg-info/top_level.txt

@@ -0,0 +1 @@
+flecsi_skeleton