From d3d6b0072ee641e5a9ed279f18ed09b8619f5a85 Mon Sep 17 00:00:00 2001
From: Kyle Klenk <kyle.c.klenk@gmail.com>
Date: Wed, 24 Aug 2022 02:56:54 +0000
Subject: [PATCH] added documentation
---
build/CMakeLists.txt | 15 +-
build/source/actors/job_actor/job_actor.cpp | 10 +-
docs/Makefile | 19 ++
docs/actors.md | 0
docs/make.bat | 35 ++++
docs/modules.rst | 6 +
.../SUMMA-Actors.md} | 4 +-
docs/source/actors.md | 3 +
docs/source/conf.py | 179 ++++++++++++++++++
docs/{ => source}/contact.md | 0
docs/source/index.rst | 20 ++
11 files changed, 279 insertions(+), 12 deletions(-)
create mode 100644 docs/Makefile
delete mode 100644 docs/actors.md
create mode 100644 docs/make.bat
create mode 100644 docs/modules.rst
rename docs/{SUMMA-Actors_documentation.md => source/SUMMA-Actors.md} (90%)
create mode 100644 docs/source/actors.md
create mode 100644 docs/source/conf.py
rename docs/{ => source}/contact.md (100%)
create mode 100644 docs/source/index.rst
diff --git a/build/CMakeLists.txt b/build/CMakeLists.txt
index 161c292..a17d1d6 100644
--- a/build/CMakeLists.txt
+++ b/build/CMakeLists.txt
@@ -231,15 +231,16 @@ add_library(SUMMA_COMM OBJECT
SUMMA_NOAHMP)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${EXEC_DIR})
-add_library(SUMMA_OBJ SHARED
+
+add_library(summa SHARED
${SUMMA_ALL})
- target_compile_options(SUMMA_OBJ PRIVATE
+ target_compile_options(summa PRIVATE
-g -O3 -ffree-line-length-none -fmax-errors=0 -fPIC -Wfatal-errors)
- target_include_directories(SUMMA_OBJ PRIVATE
+ target_include_directories(summa PRIVATE
"/usr/include"
${netCDF_INCLUDES}
${LAPACK_INCLUDES})
- target_link_libraries(SUMMA_OBJ PUBLIC
+ target_link_libraries(summa PUBLIC
${netCDF_LIBRARIES}
${LAPACK_LIBRARIES}
SUMMA_COMM)
@@ -252,7 +253,6 @@ find_package(LAPACK REQUIRED)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${EXEC_DIR})
-
add_executable(${EXEC_NAME}
${ACTORS_GLOBAL}
${HRU_ACTOR}
@@ -278,4 +278,7 @@ add_executable(${EXEC_NAME}
${CAF_LIBRARIES}
${netCDF_LIBRARIES}
${LAPACK_LIBRARIES}
- SUMMA_OBJ)
\ No newline at end of file
+ -lcaf_core
+ -lcaf_io
+ summa
+ -lsumma)
\ No newline at end of file
diff --git a/build/source/actors/job_actor/job_actor.cpp b/build/source/actors/job_actor/job_actor.cpp
index bd91bfa..405731c 100644
--- a/build/source/actors/job_actor/job_actor.cpp
+++ b/build/source/actors/job_actor/job_actor.cpp
@@ -167,11 +167,11 @@ behavior job_actor(stateful_actor<job_state>* self, int start_gru, int num_gru,
[=](done_file_access_actor_init) {
// Init GRU Actors and the Output Structure
- // self->send(self, init_hru_v);
- auto gru = self->spawn(gru_actor, 1, 1,
- self->state.config_path,
- self->state.output_struct_size, self);
- self->send(gru, init_gru_v);
+ self->send(self, init_hru_v);
+ // auto gru = self->spawn(gru_actor, 1, 1,
+ // self->state.config_path,
+ // self->state.output_struct_size, self);
+ // self->send(gru, init_gru_v);
},
[=](done_init_gru) {
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..69fe55e
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+SOURCEDIR = source
+BUILDDIR = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file
diff --git a/docs/actors.md b/docs/actors.md
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000..543c6b1
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+ echo.
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+ echo.installed, then set the SPHINXBUILD environment variable to point
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
+ echo.may add the Sphinx directory to PATH.
+ echo.
+ echo.If you don't have Sphinx installed, grab it from
+ echo.http://sphinx-doc.org/
+ exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd
diff --git a/docs/modules.rst b/docs/modules.rst
new file mode 100644
index 0000000..52eef36
--- /dev/null
+++ b/docs/modules.rst
@@ -0,0 +1,6 @@
+Summa-Actors
+============
+
+.. toctree::
+ :maxdepth: 4
+
diff --git a/docs/SUMMA-Actors_documentation.md b/docs/source/SUMMA-Actors.md
similarity index 90%
rename from docs/SUMMA-Actors_documentation.md
rename to docs/source/SUMMA-Actors.md
index a62bb59..d3658a9 100644
--- a/docs/SUMMA-Actors_documentation.md
+++ b/docs/source/SUMMA-Actors.md
@@ -3,4 +3,6 @@
SUMMA-Actors is a beta software that currently does not have the full capabilities of the original version of SUMMA. The most notable
feature not currently implemented is the simulation of lateral flows. SUMMA-Actors can solve for HRUs that do not have any dependencies on other HRUs. Although we are working to implement the full functionality of SUMMA into SUMMA-Actors.
-The documentation is organized as follows. We provide information for installing SUMMA-Actors on your system as well as some information for how to install SUMMA-Actors on Clusters such as the ones provided by Compute Canada.
\ No newline at end of file
+The documentation is organized as follows. We provide information for installing SUMMA-Actors on your system as well as some information for how to install SUMMA-Actors on Clusters such as the ones provided by Compute Canada.
+
+[The Actor Model](actors.md)
\ No newline at end of file
diff --git a/docs/source/actors.md b/docs/source/actors.md
new file mode 100644
index 0000000..2de1620
--- /dev/null
+++ b/docs/source/actors.md
@@ -0,0 +1,3 @@
+# Introduction to Actors
+
+The actor model is a concurrency model where the fundemental unit of computation is the actor. The actor is considered the fundemental unit of computation because it encapulates what it means to compute inside the actor. Specifically, this means an actor has a thread of execution, the ability to save state, and the ability to message actors. This is what is fundemental to a computer, where a computer has the ability to execute instructions, save state in either RAM (volitle) or HDD/SDD (non-volitle), and connected to a network in which it can communicate with other computers.
\ No newline at end of file
diff --git a/docs/source/conf.py b/docs/source/conf.py
new file mode 100644
index 0000000..e723e8e
--- /dev/null
+++ b/docs/source/conf.py
@@ -0,0 +1,179 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'SUMMA-Actors'
+copyright = '2022, Kyle Klenk, Kevin R. Green, Raymond Spiteri'
+author = 'Kyle Klenk, Kevin R. Green, Raymond Spiteri'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = ''
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.doctest',
+ 'myst_parser',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.md'
+
+# The master toctree document.
+master_doc = 'SUMMA-Actors'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = 'en'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself. Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'SUMMA-Actorsdoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+ # The paper size ('letterpaper' or 'a4paper').
+ #
+ # 'papersize': 'letterpaper',
+
+ # The font size ('10pt', '11pt' or '12pt').
+ #
+ # 'pointsize': '10pt',
+
+ # Additional stuff for the LaTeX preamble.
+ #
+ # 'preamble': '',
+
+ # Latex figure (float) alignment
+ #
+ # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ (master_doc, 'SUMMA-Actors.tex', 'SUMMA-Actors Documentation',
+ 'Kyle Klenk, Kevin R. Green, Raymond Spiteri', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ (master_doc, 'summa-actors', 'SUMMA-Actors Documentation',
+ [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ (master_doc, 'SUMMA-Actors', 'SUMMA-Actors Documentation',
+ author, 'SUMMA-Actors', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------
diff --git a/docs/contact.md b/docs/source/contact.md
similarity index 100%
rename from docs/contact.md
rename to docs/source/contact.md
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..e12722f
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,20 @@
+.. SUMMA-Actors documentation master file, created by
+ sphinx-quickstart on Tue Aug 23 17:21:15 2022.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+SUMMA-Actors Documentation
+========================================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
--
GitLab