Merge pull request #114 from HPC-SimTools/update_code_docs

More updates for code docs

README.md

@@ -1,6 +1,6 @@
 # Integrated Plasma Simulator (IPS) Framework
 
-The documentation can be found at
+The documentation can be found at https://ips-framework.readthedocs.io
 
 Installation is available via pip:
 

doc/examples/helloworld/setup.py

@@ -4,6 +4,6 @@
 setup(
     name="helloworld",
     version="1.0.0",
-    install_requires=["ipsframework==0.2.1"],
+    install_requires=["ipsframework"],
     packages=find_packages(),
 )

doc/the_code.rst

@@ -7,7 +7,7 @@ IPS
 
 Framework
 ---------
-.. autoclass:: ipsframework.Framework
+.. autoclass:: ipsframework.ips.Framework
    :members:
    :undoc-members:
 
@@ -55,6 +55,13 @@ Component
    :members:
    :undoc-members:
 
+Component Registry
+------------------
+
+.. automodule:: ipsframework.componentRegistry
+   :members:
+   :undoc-members:
+
 Configuration Manager
 ---------------------
 .. automodule:: ipsframework.configurationManager
@@ -64,18 +71,9 @@ Configuration Manager
 Services
 --------
 .. automodule:: ipsframework.services
-
-.. autoclass:: ServicesProxy
-   :members:
-   :undoc-members:
-
-.. autoclass:: Task
-   :members:
-   :undoc-members:
-
-.. autoclass:: TaskPool
    :members:
    :undoc-members:
+   :exclude-members: dask, distributed
 
 Other Utilities
 ---------------

doc/user_guides/component_package.rst

@@ -6,20 +6,19 @@ package. This is also an example of using ``MODULE`` instead of
 ``SCRIPT`` in the component configuration section.
 
 The examples will be a simple hello world with one driver and one
-worker. The only requirement of the package is ``ipsframework`` and we
-are using the specific version v0.2.1. The ipsframework should be
-automatically installed from pypi when install ipsexamples but you can
-manually install it from pypi with
+worker. The only requirement of the package is ``ipsframework``. The
+ipsframework should be automatically installed from pypi when install
+ipsexamples but you can manually install it from pypi with
 
 .. code-block:: bash
 
-    python -m pip install ipsframework==0.2.1
+    python -m pip install ipsframework
 
 Or to install it directly from github you can do
 
 .. code-block:: bash
 
-    python -m pip install git+https://github.com/HPC-SimTools/IPS-framework.git@v0.2.1
+    python -m pip install git+https://github.com/HPC-SimTools/IPS-framework.git
 
 To create this project locally, create the following file structure
 

doc/user_guides/nersc_conda.rst

@@ -6,6 +6,11 @@ NERSC recommends the use of anaconda environments to mange python
 installs, see `Brief introduction to Python at NERSC
 <https://docs.nersc.gov/development/languages/python/overview/>`_.
 
+There is a conda environment already constructed and maintained for
+the *atom* project created using the `shareable environment`_
+method. You can activate it by running ``source
+/global/common/software/atom/cori/ips-framework-new/bin/activate``.
+
 Creating you own conda environment
 ----------------------------------
 
@@ -53,6 +58,8 @@ environment to run use, see `Running Python in a batch job
   source activate my_ips_env
   ips.py --config=simulation.config --platform=platform.conf
 
+.. _shareable environment:
+
 Creating a shareable environment on /global/common/software
 -----------------------------------------------------------
 

ipsframework/component.py

@@ -1,6 +1,7 @@
 # -------------------------------------------------------------------------------
 # Copyright 2006-2020 UT-Battelle, LLC. See LICENSE for more information.
 # -------------------------------------------------------------------------------
+"""IPS Framework Component"""
 import sys
 import os
 import weakref
@@ -12,6 +13,12 @@ class Component:
     """
     Base class for all IPS components.  Common set up, connection and
     invocation actions are implemented here.
+
+    :param services: service proxy to communicate with framework
+    :type services: :class:`~ipsframework.services.ServicesProxy`
+
+    :param config: configuration dictionary for this component
+    :type config: dict
     """
 
     def __init__(self, services, config):

ipsframework/ips.py

@@ -101,7 +101,7 @@ class Framework:
     :type config_file_list: list
 
     :param log_file_name: A file name where Framework logging messages are placed.
-    :type log_file_list: str
+    :type log_file_name: str
 
     :param platform_file_name: The name of the platform
             configuration file used in the simulation.  If not