From c4f802e2d1cd1253472895e957e747dd8606bd66 Mon Sep 17 00:00:00 2001
From: Kyle Klenk <kyle.c.klenk@gmail.com>
Date: Thu, 18 Apr 2024 19:12:04 +0000
Subject: [PATCH] Clean up of unnecessary files
---
build/build_scripts/build_v4_local.sh | 4 +-
docs/Makefile | 19 ---
docs/make.bat | 35 -----
docs/modules.rst | 6 -
docs/source/Distributed-Documentation.md | 17 ---
docs/source/SUMMA-Actors.md | 8 -
docs/source/actor_implementations.md | 30 ----
docs/source/actors.md | 3 -
docs/source/conf.py | 179 -----------------------
docs/source/config_file.md | 30 ----
docs/source/contact.md | 0
docs/source/index.rst | 20 ---
12 files changed, 2 insertions(+), 349 deletions(-)
delete mode 100644 docs/Makefile
delete mode 100644 docs/make.bat
delete mode 100644 docs/modules.rst
delete mode 100644 docs/source/Distributed-Documentation.md
delete mode 100644 docs/source/SUMMA-Actors.md
delete mode 100644 docs/source/actor_implementations.md
delete mode 100644 docs/source/actors.md
delete mode 100644 docs/source/conf.py
delete mode 100644 docs/source/config_file.md
delete mode 100644 docs/source/contact.md
delete mode 100644 docs/source/index.rst
diff --git a/build/build_scripts/build_v4_local.sh b/build/build_scripts/build_v4_local.sh
index 5831b36..a3f990e 100755
--- a/build/build_scripts/build_v4_local.sh
+++ b/build/build_scripts/build_v4_local.sh
@@ -3,8 +3,8 @@
# If most libraries were installed with apt-get, then the following should work
# Otherwise, you may need to adjust the paths
export FC=gfortran # Fortran compiler family
-export LINK_DIRS='/usr/local/lib;/usr/lib' # Link directories for cmake
-export INCLUDES_DIRS='/usr/local/include;/usr/include' # directories for INCLUDES cmake variable (cmake uses semicolons as separators)
+export LINK_DIRS='/usr/local/lib;/usr/lib' # Link directories for cmake
+export INCLUDES_DIRS='/usr/local/include;/usr/include' # directories for INCLUDES cmake variable (cmake uses semicolons as separators)
export LIBRARY_LINKS='-llapack;-lgfortran;-lnetcdff;-lnetcdf' # list of library links (cmake uses semicolons as separators)
# Set the following paths
diff --git a/docs/Makefile b/docs/Makefile
deleted file mode 100644
index 69fe55e..0000000
--- a/docs/Makefile
+++ /dev/null
@@ -1,19 +0,0 @@
-# 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/make.bat b/docs/make.bat
deleted file mode 100644
index 543c6b1..0000000
--- a/docs/make.bat
+++ /dev/null
@@ -1,35 +0,0 @@
-@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
deleted file mode 100644
index 52eef36..0000000
--- a/docs/modules.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-Summa-Actors
-============
-
-.. toctree::
- :maxdepth: 4
-
diff --git a/docs/source/Distributed-Documentation.md b/docs/source/Distributed-Documentation.md
deleted file mode 100644
index 1cc65d6..0000000
--- a/docs/source/Distributed-Documentation.md
+++ /dev/null
@@ -1,17 +0,0 @@
-# SUMMA-Distributed
-SUMMA-Distributed is an actor program that can compute the solution to HRUs using multiple computers connected in a network.
-To achieve this we had to introduce two new actors into SUMMA-Actors the client actor and the server actor. These actors in combintaiton can
-compute the solution to HRUs.
-
-To use distributed mode. Set the "distributed-mode" setting to true in the Summa_Actors_Settings.json file.
-
-## SUMMA-Server
-Run the server with:
- - summaMain -s -c /path/to/config/Summa_Actors_Settings.json
-
-The server gets its settings from Summa_Actors_Settings.json where the user can configure how many HRUs to compute and how many HRUs should be inside a batch.
-
-## SUMMA-Client
-Run the cleint with
- - summaMain -c /path/to/config/Summa_Actors_Settings.json
- The client needs the Distributed_Settings from the Summa_Actors_Settings.json file. The rest are set by the server.
\ No newline at end of file
diff --git a/docs/source/SUMMA-Actors.md b/docs/source/SUMMA-Actors.md
deleted file mode 100644
index d3658a9..0000000
--- a/docs/source/SUMMA-Actors.md
+++ /dev/null
@@ -1,8 +0,0 @@
-# SUMMA-Actors Documentation Guide
-
-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.
-
-[The Actor Model](actors.md)
\ No newline at end of file
diff --git a/docs/source/actor_implementations.md b/docs/source/actor_implementations.md
deleted file mode 100644
index 29f5db0..0000000
--- a/docs/source/actor_implementations.md
+++ /dev/null
@@ -1,30 +0,0 @@
-# Actor Implementations
-Here we introduce you to the implmentened actors and their behaviours
-
-
-# Normal Summa (No Distributed)
-
-## Summa Actor
-This is the top level actor that is spawned after the user invokes the program.
-This actor is used to control job actors and batch sizes. The user can specifies how large a simulation of GRUs should be from the command line. This actor can then break that into smaller jobs to save on RAM.
-
-## Job Actor
-
-## File Access Actor
-
-### Loading in Forcing Data
-Loads Forcing Files in one at a time. The loading of files is initiated by the HRU_Actor by a message to request forcing data.
-
-## GRU Actor
-
-## HRU Actor
-
-
-
-
-# SUMMA-Distributed (Includes Additional Actors)
-
-
-## Server Actor
-
-## Client Actor
\ No newline at end of file
diff --git a/docs/source/actors.md b/docs/source/actors.md
deleted file mode 100644
index 2de1620..0000000
--- a/docs/source/actors.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# 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
deleted file mode 100644
index e723e8e..0000000
--- a/docs/source/conf.py
+++ /dev/null
@@ -1,179 +0,0 @@
-# -*- 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/source/config_file.md b/docs/source/config_file.md
deleted file mode 100644
index 94e8715..0000000
--- a/docs/source/config_file.md
+++ /dev/null
@@ -1,30 +0,0 @@
-# config_file
-
-The configuration file is used to adjust the settings for summa actors. This file is passed into SUMMA using the -c argument for running summa.
-
-The settings are defined as follows:
-
-## Distributed_Settings - For client and server actors
-- distributed_mode
-- hostname
-- port
-- total_hru_count
-- num_hru_per_batch
-- heartbeat_interval
-- lost_node_threshold
-
-## Summa_Actor
-- max_gru_per_job
-
-## File_Access_Actor
-- num_vectors_in_output_manager
-
-## Job_Actor
-- file_manager_path
-- output_structure_size
-- output_csv
-- csv_path
-
-## HRU_Actor
-- print_output
-- output_frequency
\ No newline at end of file
diff --git a/docs/source/contact.md b/docs/source/contact.md
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/source/index.rst b/docs/source/index.rst
deleted file mode 100644
index e12722f..0000000
--- a/docs/source/index.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-.. 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